From 28b3d05590e95803c878b064544509569538472b Mon Sep 17 00:00:00 2001 From: SamTV12345 <40429738+samtv12345@users.noreply.github.com> Date: Sat, 29 Apr 2023 17:08:43 +0200 Subject: [PATCH] Added cli documentation. --- README.md | 4 ++++ docs/CLI.md | 23 +++++++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 docs/CLI.md diff --git a/README.md b/README.md index 3a9e408e..ec211f75 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,10 @@ Several Auth methods are described here: [AUTH.md](docs/AUTH.md) Hosting options are described here: [HOSTING.md](docs/HOSTING.md) +# CLI usage + +The cli usage is described here: [CLI.md](docs/CLI.md) + # Environment Variables | Variable | Description | Default | diff --git a/docs/CLI.md b/docs/CLI.md new file mode 100644 index 00000000..c4f6c918 --- /dev/null +++ b/docs/CLI.md @@ -0,0 +1,23 @@ +# CLI usage + +The CLI can be used to update, remove, list registered users in PodFetch. You can get help anytime by typing --help/help + +# Usage + +# Get general help + +```bash +podfetch --help +``` + +# Get help for a specific command + +```bash +podfetch --help +``` + +e.g. + +```bash +podfetch users --help +``` \ No newline at end of file