Added cli documentation.

SamTV12345 · Apr 29, 2023 · 28b3d05 · 28b3d05
1 parent 44961ff
commit 28b3d05
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git 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
@@ -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 <command> --help
+```
+
+e.g. 
+
+```bash
+podfetch users --help
+```