Browse Source

README tweaks

tags/v0.3.0
Russ Garrett 5 years ago
parent
commit
275bed4333
No account linked to committer's email address
1 changed files with 12 additions and 12 deletions
  1. 12
    12
      README.md

+ 12
- 12
README.md View File

@@ -34,7 +34,7 @@ And set a channel topic:
34 34
 
35 35
     echo "%TOPIC #channel Channel topic" | nc irccat-host 12345
36 36
 
37
-IRC formatting is supported (see a full [list of codes](tcplistener/colours.go#L5)):
37
+IRC formatting is supported (see a full [list of codes](dispatcher/colours.go#L5)):
38 38
 
39 39
     echo "Status is%GREEN OK %NORMAL" | nc irccat-host 12345
40 40
 
@@ -44,20 +44,20 @@ HTTP listeners are configured by setting keys under `http.listeners`.
44 44
 
45 45
 ### Generic HTTP Endpoint
46 46
 ```json
47
-	"generic": true
47
+"generic": true
48 48
 ```
49 49
 
50 50
 An endpoint for sending messages similar to the TCP port. You can use curl in lieu
51
-of netcat, with "-d @-" to read POST data from stdin, like so:
51
+of netcat, with `-d @-` to read POST data from stdin, like so:
52 52
 
53 53
     echo "Hello world" | curl -d @- http://irccat-host/send
54 54
 
55
-Everything that works via netcat also works by POST to /send. Note that this endpoint
55
+Everything that works via netcat also works by POST to `/send`. Note that this endpoint
56 56
 is unauthenticated.
57 57
 
58 58
 ### Grafana Webhook
59 59
 ```json
60
-	"grafana": "#channel"
60
+"grafana": "#channel"
61 61
 ```
62 62
 
63 63
 Grafana alerts can be sent to `/grafana`. They will be sent to the
@@ -66,13 +66,13 @@ unauthenticated.
66 66
 
67 67
 ### GitHub Webhooks
68 68
 ```json
69
-	"github": {
70
-		"secret": "my_secret",
71
-		"default_channel": "#channel",
72
-		"repositories": {
73
-		    "irccat": "#irccat-dev"
74
-		}
75
-       	}
69
+"github": {
70
+	"secret": "my_secret",
71
+	"default_channel": "#channel",
72
+	"repositories": {
73
+	    "irccat": "#irccat-dev"
74
+	}
75
+}
76 76
 ```
77 77
 
78 78
 Receives GitHub webhooks at `/github`. Currently supports issues, issue comments,

Loading…
Cancel
Save