summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWojciech Kwolek <wojciech@kwolek.io>2024-06-08 05:54:28 +0200
committerWojciech Kwolek <wojciech@kwolek.io>2024-06-08 05:54:28 +0200
commitd51b534e2155fb2f8fd125a94321674b202868ed (patch)
treed4d10a8502e42190f6223ce5c6aa29bcbe04a601
parenta70eec9c403b34b56a396801c9c4f18678bfbf31 (diff)
readme part 1
-rw-r--r--README.md22
1 files changed, 21 insertions, 1 deletions
diff --git a/README.md b/README.md
index 13eeb5c..13a348f 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,21 @@
-# dmenu \ No newline at end of file
+# dmenu
+
+A `dmenu`-like extension for Raycast.
+
+Inspired by [this orange website commenter](https://news.ycombinator.com/item?id=40606300).
+
+## Usage
+
+1. [Install the extension.](#installation)
+2. Download the [dmenu_raycast](./dmenu_raycast) script and put it somewhere in your `$PATH`
+3. Run something like `printf 'one\ntwo\nthree' | dmenu_raycast`
+
+`dmenu_raycast` will either print the selected item to stdout, or exit 0 if the user cancelled without selecting an item.
+
+Whitespace is stripped, but this might change in the future once I check if `dmenu` also does that lol.
+
+**TODO:** `-p` (prompt) support
+
+## Installation
+
+TODO