aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6e12832
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# remembering
+
+Add memory to [`dmenu`][dmenu], [`fzf`][fzf] and similar tools.
+
+Replace:
+```shell
+$ ls | fzf
+```
+
+with:
+```shell
+$ ls | remembering -p fzf-sample -c fzf
+```
+
+and see your previous choices from `fzf` start to appear at the beginning of the list.
+
+[dmenu]: https://tools.suckless.org/dmenu/
+[fzf]: https://github.com/junegunn/fzf
+
+## Installation
+
+Get the latest tarball and install it:
+
+```shell
+wget https://git.euandreh.xyz/remembering/snapshot/remembering-0.1.0.tar.gz
+pax -rzf remembering-0.1.0.tar.gz
+cd remembering-0.1.0
+[sudo] make install
+```