1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..15c4a0b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# cbink
+
+a simple c client for the [bink](https://git.tilde.town/nebula/bink)
+microblogging platform.  there is no central server, only files in
+`/home/*/.bink`, named after the number of nanoseconds since the unix
+epoch at the time of their creation.
+
+## dependencies
+
+* a c17-compatible c compiler
+* libncursesw (with unicode support)
+
+## keyboard shortcuts
+
+* `k` / `Up` --- up
+* `j` / `Down` -- down
+* `d` / `Space` / `PageDown` / `Ctrl-D` --- page down
+* `b` / `u` / `PageUp` / `Ctrl-U` --- page up
+* `g` / `Home` -- top of feed
+* `G` / `End` -- bottom of feed
+* `r` -- refresh feed
+* `c` -- create new post
+* `v` -- view post at top of window in `less(1)`
+* `e` -- edit post at top of window (must be yours)