Docs updates

README.md

@@ -2,8 +2,18 @@
 [![Build Status](https://travis-ci.org/irccloud/irccat.svg?branch=master)](https://travis-ci.org/irccloud/irccat)
 
 A reimplementation of [irccat](https://github.com/RJ/irccat), the
-original ChatOps tool, in Go. irccat lets you easily send events
-to IRC channels from scripts and other applications.
+original ChatOps tool, in Go.
+
+irccat lets you easily send events to IRC channels from scripts and
+other applications.
+
+## Installation
+
+Download the [latest
+release](https://github.com/irccloud/irccat/releases) from Github, put
+the [example
+config](https://github.com/irccloud/irccat/blob/master/examples/irccat.json)
+in `/etc/irccat.json` or the local directory, and run!
 
 ## TCP → IRC
 Just cat a string to the TCP port - it'll be sent to the first channel
@@ -38,12 +48,12 @@ so you should make sure you firewall them from the world.
 ## IRC → Shell
 You can use irccat to execute commands from IRC:
 
-    ?commandname arguments
+    ?commandname string of arguments
 
 This will call your `commands.handler` script with the command-line
 arguments:
 
-    nickname, [channel], respond_to, commandname, [arguments]
+    nickname [channel] respond_to commandname [string of arguments]
 
 irccat will only recognise commands from users in private message if
 the user is joined to `commands.auth_channel` defined in the config.

examples/irccat.json

@@ -6,20 +6,20 @@
     "tls_key": "",
     "tls_cert": "",
     "listeners": {
-      "grafana": "#russtest"
+      "grafana": "#channel"
     }
   },
   "irc": {
-    "server": "irc.irccloud.com:6667",
-    "tls": false,
-    "tls_skip_verify": true,
-    "nick": "irccat2",
+    "server": "irc.example.com:6697",
+    "tls": true,
+    "tls_skip_verify": false,
+    "nick": "irccat",
     "realname": "IRCCat",
     "identify_pass": "",
-    "channels": ["#russtest"]
+    "channels": ["#channel"]
   },
   "commands": {
-    "auth_channel": "#russtest",
+    "auth_channel": "#channel",
     "handler": "./examples/command_runner.py",
     "max_response_lines": 15
   }