docs: Add usage info and credits in README.md for rM-SSH-Upload
docs: Update README with project name and usage help output
This commit is contained in:
parent
4d1a69f2e3
commit
77700568df
1 changed files with 19 additions and 0 deletions
19
README.md
Normal file
19
README.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
# rm-sync
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
Usage: rm-sync.sh [options] [PDF files...]
|
||||
|
||||
Options:
|
||||
--user <username> Specify the username (default: root)
|
||||
--host <hostname> Specify the host (default: 10.11.99.1)
|
||||
--help, -h Display this help message
|
||||
|
||||
PDF files:
|
||||
List of PDF files to be processed
|
||||
```
|
||||
|
||||
## Credits
|
||||
|
||||
This project is inspired by [rM-SSH-Upload](https://github.com/Riebart/rM-SSH-Upload).
|
Loading…
Reference in a new issue