aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Ankarström <john@ankarstrom.se>2019-01-10 18:08:54 +0100
committerJohn Ankarström <john@ankarstrom.se>2019-01-10 18:10:39 +0100
commit2fab304c457ad7e08332c1b950f7c97a5dffc058 (patch)
tree08b815825c97116a0835d2c3e369b656a97da4b8
parent9ded858901e27d1fe7360e2719cc2e4c5d8aa966 (diff)
downloadrepl-2fab304c457ad7e08332c1b950f7c97a5dffc058.tar.gz
clarified readme
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7736718..47066c4 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,30 @@
`repl.c` creates a read-eval-print loop out of any command. It is
a simple and readable C program that requires GNU readline.
+In other words, it's a REPL for command-line interfaces that always
+require a "prefix" command. If you're tired of having to type `git`
+everytime you want to issue a `git` command:
+
+ $ git init
+ $ git add .
+ $ git status
+ $ git commit
+ $ git push
+ $ git status
+
+... then you can do this instead:
+
+ $ repl git
+ git > init
+ git > add .
+ git > status
+ git > commit
+ git > push
+ git > status
+
+The program automatically prefixes each command with `git`, so that
+you don't have to type it.
+
### Installation
The following commands install `repl` in `/usr/local/bin` and