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:
Moritz Böhme 2025-02-13 13:22:24 +01:00
parent 4d1a69f2e3
commit 77700568df
Signed by: moritz
GPG key ID: 970C6E89EB0547A9

19
README.md Normal file
View 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).