Pārlūkot izejas kodu

Docs updates

tags/v0.1.5
Russ Garrett 7 gadus atpakaļ
vecāks
revīzija
e0013fbf9f
Revīzijas autora e-pasta adrese nav piesaistīta nevienam kontam
2 mainītis faili ar 21 papildinājumiem un 11 dzēšanām
  1. 14
    4
      README.md
  2. 7
    7
      examples/irccat.json

+ 14
- 4
README.md Parādīt failu

2
 [![Build Status](https://travis-ci.org/irccloud/irccat.svg?branch=master)](https://travis-ci.org/irccloud/irccat)
2
 [![Build Status](https://travis-ci.org/irccloud/irccat.svg?branch=master)](https://travis-ci.org/irccloud/irccat)
3
 
3
 
4
 A reimplementation of [irccat](https://github.com/RJ/irccat), the
4
 A reimplementation of [irccat](https://github.com/RJ/irccat), the
5
-original ChatOps tool, in Go. irccat lets you easily send events
6
-to IRC channels from scripts and other applications.
5
+original ChatOps tool, in Go.
6
+
7
+irccat lets you easily send events to IRC channels from scripts and
8
+other applications.
9
+
10
+## Installation
11
+
12
+Download the [latest
13
+release](https://github.com/irccloud/irccat/releases) from Github, put
14
+the [example
15
+config](https://github.com/irccloud/irccat/blob/master/examples/irccat.json)
16
+in `/etc/irccat.json` or the local directory, and run!
7
 
17
 
8
 ## TCP → IRC
18
 ## TCP → IRC
9
 Just cat a string to the TCP port - it'll be sent to the first channel
19
 Just cat a string to the TCP port - it'll be sent to the first channel
38
 ## IRC → Shell
48
 ## IRC → Shell
39
 You can use irccat to execute commands from IRC:
49
 You can use irccat to execute commands from IRC:
40
 
50
 
41
-    ?commandname arguments
51
+    ?commandname string of arguments
42
 
52
 
43
 This will call your `commands.handler` script with the command-line
53
 This will call your `commands.handler` script with the command-line
44
 arguments:
54
 arguments:
45
 
55
 
46
-    nickname, [channel], respond_to, commandname, [arguments]
56
+    nickname [channel] respond_to commandname [string of arguments]
47
 
57
 
48
 irccat will only recognise commands from users in private message if
58
 irccat will only recognise commands from users in private message if
49
 the user is joined to `commands.auth_channel` defined in the config.
59
 the user is joined to `commands.auth_channel` defined in the config.

+ 7
- 7
examples/irccat.json Parādīt failu

6
     "tls_key": "",
6
     "tls_key": "",
7
     "tls_cert": "",
7
     "tls_cert": "",
8
     "listeners": {
8
     "listeners": {
9
-      "grafana": "#russtest"
9
+      "grafana": "#channel"
10
     }
10
     }
11
   },
11
   },
12
   "irc": {
12
   "irc": {
13
-    "server": "irc.irccloud.com:6667",
14
-    "tls": false,
15
-    "tls_skip_verify": true,
16
-    "nick": "irccat2",
13
+    "server": "irc.example.com:6697",
14
+    "tls": true,
15
+    "tls_skip_verify": false,
16
+    "nick": "irccat",
17
     "realname": "IRCCat",
17
     "realname": "IRCCat",
18
     "identify_pass": "",
18
     "identify_pass": "",
19
-    "channels": ["#russtest"]
19
+    "channels": ["#channel"]
20
   },
20
   },
21
   "commands": {
21
   "commands": {
22
-    "auth_channel": "#russtest",
22
+    "auth_channel": "#channel",
23
     "handler": "./examples/command_runner.py",
23
     "handler": "./examples/command_runner.py",
24
     "max_response_lines": 15
24
     "max_response_lines": 15
25
   }
25
   }

Notiek ielāde…
Atcelt
Saglabāt