aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2023-09-21 01:36:22 -0700
committerFuwn <[email protected]>2023-09-21 01:36:22 -0700
commitacea7ba37a0bffa72ef16e692985c64cb34de7cc (patch)
tree519e7af4b63404a4677bac9826a0993dcad02f83
parentdocs(suzuri): complete help output (diff)
downloadsuzuri-acea7ba37a0bffa72ef16e692985c64cb34de7cc.tar.xz
suzuri-acea7ba37a0bffa72ef16e692985c64cb34de7cc.zip
docs(readme): add complete help output
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index bd40c6a..14883a7 100644
--- a/README.md
+++ b/README.md
@@ -20,8 +20,16 @@ Obtain your sumi.news token via the `s` cookie on sumi.news.
### `--help`
```text
-usage: sumi [token] [folder]
+usage: sumi token [folder]
+positional arguments:
+ token sumi.news session token
+ folder sumi.news feed folder
+
+environment variables:
+ SUZURI_TOKEN substitution for [token]
+ SUZURI_FOLDER substitution for [folder]
+ SUZURI_REVERSE reverse the output feed
```
Optionally, omit the token and folder arguments and export the environment