released at 0.3.2 (#130)

Co-authored-by: Michael Czigler <contact@mcpcpc.com>

1 files changed, 55 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..38f8d8c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+# kirc
+
+kirc (KISS for IRC) is a tiny IRC client written in POSIX C99.
+
+## Installation
+
+Building and installing from source:
+
+	git clone https://github.com/mcpcpc/kirc
+	cd kirc
+	make
+	make install
+
+## Usage
+
+Consult `man kirc` for a full list and explanation of available arguments.
+
+    kirc [-s hostname] [-p port] [-c channels] [-n nickname] [-r realname]
+         [-u username] [-k password] [-a token] [-o logfile] [-e|x|v|V]
+
+## Command Aliases
+
+    <message>                   send PRIVMSG to the current channel.
+    @<channel|nick> <message>   send PRIVMSG to a specified channel or nick.
+    @@<channel|nick> <message>  send CTCP ACTION message to a specified channel
+                                or nick (if no channel or nick is specified, the
+                                message will be sent to the default channel).
+    /<command>                  send command to the IRC server (see RFC 2812).
+    /#<channel>                 assign new default message channel.
+
+## Key Bindings
+
+    CTRL+B or LEFT ARROW        move the cursor one character to the left.
+    CTRL+F or RIGHT ARROW       move the cursor one character to the right.
+    CTRL+P or UP ARROW          move to previous record in the input history buffer.
+    CTRL+N or DOWN ARROW        move to next record in the input history buffer.
+    CTRL+E                      move the cursor to the end of the line.
+    CTRL+A or HOME              move the cursor to the start of the line.
+    CTRL+W                      delete the previous word.
+    CTRL+U                      delete the entire line.
+    CTRL+K                      delete the from current character to end of line.
+    CTRL+D                      delete the character to the right of cursor.
+    CTRL+C                      force quit kirc.
+    CTRL+T                      swap character at cursor with previous character.
+    CTRL+H                      equivalent to backspace.
+
+## Support Documentation
+
+Please refer to the [official homepage](http://kirc.io/docs.html) for examples, 
+troubleshooting and use cases.
+
+## Contact
+
+For any further questions or concerns, feel free to send me an 
+[email](michaelczigler[at]mcpcpc[dot]com).