summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/README.md b/README.md
index fa96d64..24508a3 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,11 @@ To build:
The resulting executable will be called "miaowe".
-Miaowe includes no networking code of its own, but assumes stdin and stdout will be connected to an IRC server. A zsh script, nya.sh, is included to help with this. Users of other shells may need to adjust the script to work with their shell. NickServ login credentials are placed in a file called "conn", on the first line and separated by a space. Image files are read from the working directory.
+Miaowe includes no networking code of its own, but assumes stdin and stdout will be connected to an IRC server. A zsh script, nya.sh, is included to help with this. Users of other shells may need to adjust the script to work with their shell. NickServ login credentials are placed in a file called "conn" (in the parent of miaowe's PWD), on the first line and separated by a space. Image files are read from the working directory. If nya.sh is used, image_directory becomes miaowe's PWD.
+
+Available commands:
+* List -- lists all files in PWD
+* Quit -- quits
To run:
@@ -18,4 +22,4 @@ To run:
or:
- ./nya.sh <channel>
+ ./nya.sh <channel> <image_directory>