aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar piotrruss <mail@pruss.it> 2022-05-07 18:30:56 +0100
committerGravatar piotrruss <mail@pruss.it> 2022-05-07 18:34:56 +0100
commitf3d9bf70794a7bed776b6e951ac2f10c9ca1b2f3 (patch)
tree0689363f9f5e4ce1e669416e2e68aac5c2601582 /README.md
parent8f8e283c4efd3ea76cce0bd2b58e3176593a7914 (diff)
downloadnotes_cli-f3d9bf70794a7bed776b6e951ac2f10c9ca1b2f3.tar.gz
notes_cli-f3d9bf70794a7bed776b6e951ac2f10c9ca1b2f3.tar.bz2
notes_cli-f3d9bf70794a7bed776b6e951ac2f10c9ca1b2f3.zip
added readme & screenshot
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dd8dd30
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Notes CLI
+This app is a terminal client for the Notes app.
+To use it you need to first create account on the [apps.pruss.it](https://apps.pruss.it) website.
+
+Key bindings (press [h] to view from the script):
+
+> [q] - Quit
+> [h] - Help
+> [up/k] - Previous note
+> [down/j] - Next note
+> [enter/o] - Open note
+
+Options that will be added:
+
+> [c] - Create note
+> [r] - Rename note
+> [s] - Sort note
+
+Screenshot:
+
+![Game of life](screenshot.jpg)