From 617b4983b929d64a9841580ae6a4ae5a79c58c36 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moritz=20B=C3=B6hme?= Date: Thu, 13 Feb 2025 13:22:24 +0100 Subject: [PATCH] docs: Add usage info and credits in README.md for rM-SSH-Upload docs: Update README with project name and usage help output --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..30ecc7f --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# rm-sync + +## Usage + +Usage: rm-sync.sh [options] [PDF files...] + +Options: + --user Specify the username (default: root) + --host 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).