Adding transfer to manpage and README

This commit is contained in:
Alex Epstein 2017-08-04 08:24:24 -04:00
parent 10975bc23b
commit 3e573f84c9
4 changed files with 82 additions and 1 deletions

View File

@ -215,7 +215,7 @@ Valid items are: shows, books, music, artists, movies, authors, games
* After getting the API key run the following line ```export TASTE_API_KEY="yourAPIKeyGoesHere" >> ~/.bash_profile```
## todo
## Todo
A simplistic command line todo list
@ -226,6 +226,16 @@ A simplistic command line todo list
</div>
## Transfer
Quickly transfer files from the command line.
<div align="center">
<img max-height="500px" max-width="500px" src="https://github.com/alexanderepstein/Bash-Snippets/blob/master/transfer/transfer.png?raw=true">
</div>
## Weather

View File

@ -540,6 +540,53 @@ todo \-c
.
.IP "" 0
.
.SS "Transfer"
Description: Quickly transfer files from the command line\.
.
.P
Usage: transfer [flags] or transfer [flag] [args]
.
.IP "\(bu" 4
\-s Upload a single file, takes in file path as argument
.
.IP "\(bu" 4
\-d Download a single file
.
.IP "" 4
.
.nf
* First arg: Output file directory
* Second arg: File url id
* Third arg: File name
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
\-u Update Bash\-Snippet Tools
.
.IP "\(bu" 4
\-h Show the help
.
.IP "\(bu" 4
\-v Get the tool version
.
.IP "" 0
.
.P
Examples:
.
.IP "\(bu" 4
transfer \-s ~/fileToTransfer\.txt
.
.IP "\(bu" 4
transfer \-d ~/outputDirectory fileID fileName
.
.IP "" 0
.
.SS "Weather"
Description: Provides a 3 day forecast on your current location or a specified location\. With no flags Weather will default to your current location\.
.

View File

@ -383,6 +383,30 @@ Examples:
* todo -c
### Transfer
Description: Quickly transfer files from the command line.
Usage: transfer [flags] or transfer [flag] [args]
* -s Upload a single file, takes in file path as argument
* -d Download a single file
* First arg: Output file directory
* Second arg: File url id
* Third arg: File name
* -u Update Bash-Snippet Tools
* -h Show the help
* -v Get the tool version
Examples:
* transfer -s ~/fileToTransfer.txt
* transfer -d ~/outputDirectory fileID fileName
### Weather
Description: Provides a 3 day forecast on your current location or a specified location.
With no flags Weather will default to your current location.

BIN
transfer/transfer.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB