summaryrefslogtreecommitdiff
path: root/clients/cli/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'clients/cli/README.md')
-rw-r--r--clients/cli/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/clients/cli/README.md b/clients/cli/README.md
new file mode 100644
index 0000000..ced2f31
--- /dev/null
+++ b/clients/cli/README.md
@@ -0,0 +1,18 @@
+# Save CLI
+
+## Requirements
+
+- `curl`, `sh`, `awk` (unix utilities)
+- `jq` (JSON parser)
+- `dmenu` (file selection menu; env-specifiable)
+- `xclip` (copy to clipboard; env-specifiable)
+
+## Docs
+
+- see `./save -h` and source-code
+
+## Installation
+
+Just move the `save` script somewhere into your `$PATH` (e.g.
+`~/.local/bin` `/usr/local/bin`). Also make sure that it's executable
+(`chmod +x save`).