diff --git a/README.md b/README.md new file mode 100644 index 0000000..dbea1e2 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# wiki-cli +A simple bash script for reading wiki articles from the command line. + +This command depends on the fact that the output of the +[wiki Makefile](https://github.com/tildeclub/site/blob/master/wiki/Makefile) +includes `.txt` output. If that script ever changed where it put files, this +script would have to be updated. + +``` +usage: wiki
+ read the article with the given 'short title' +usage: wiki --list + list all available short titles +```