Initial commit

1 files changed, 19 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ec3d16c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# ask - a simple command line asker
+`ask` is a simple command line tool to get user input. `ask` is less janky than
+`read`, more compact than `fzf`, and less bloated than `readline`-based tools.
+`ask` supports most of the typical line editing functionality (e.g. arrow keys,
+backspace, Ctrl-U) and can be used to perform fuzzy matching or basic user input
+all on a single line of terminal space. Like fuzzy find tools, `ask` plays nicely
+with unix pipelines, but it's a bit more visually compact. `ask`'s functionality
+overlaps with fuzzy finders, but if you want to see a full list of things you're
+filtering through, use `fzy` or `fzf` instead of `ask`.
+
+## Usage
+Here's a simple program to move a file from the current directory:
+
+    #!/bin/sh
+    file="`ls | ask "Pick a file: "`"
+    mv "$file" "`ask "Move $file to: "`"
+
+## License
+`ask` is released under the MIT License. See LICENSE for details.