Explorar el Código

More readme updates

tags/v0.2.2
Russ Garrett hace 7 años
padre
commit
1977e78944
No account linked to committer's email address
Se han modificado 1 ficheros con 10 adiciones y 2 borrados
  1. 10
    2
      README.md

+ 10
- 2
README.md Ver fichero

@@ -16,7 +16,7 @@ config](https://github.com/irccloud/irccat/blob/master/examples/irccat.json)
16 16
 in `/etc/irccat.json` or the local directory and customise it, and run!
17 17
 
18 18
 ## TCP → IRC
19
-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
20 20
 defined in your channel list:
21 21
 
22 22
     echo "Hello world" | nc irccat-host 12345
@@ -26,6 +26,14 @@ Or specify a channel or nickname to send to:
26 26
     echo "#channel Hello world" | nc irccat-host 12345
27 27
     echo "@nick Hello world" | nc irccat-host 12345
28 28
 
29
+You can also send to multiple recipients at once:
30
+
31
+    echo "#channel,@nick Hello world | nc irccat-host 12345
32
+
33
+And set a channel topic:
34
+
35
+    echo "%TOPIC #channel Channel topic" | nc irccat-host 12345
36
+
29 37
 IRC formatting is supported (see a full [list of
30 38
 codes](https://github.com/irccloud/irccat/blob/master/tcplistener/colours.go#L5)):
31 39
 
@@ -35,7 +43,7 @@ codes](https://github.com/irccloud/irccat/blob/master/tcplistener/colours.go#L5)
35 43
 There's a simple HTTP endpoint for sending messages:
36 44
 
37 45
     curl -X POST http://irccat-host:8045/send -d
38
-        '{"to": "#channel", "body": "Hello world"}
46
+        '{"to": "#channel", "body": "Hello world"}'
39 47
 
40 48
 There are also endpoints which support app-specific webhooks, currently:
41 49
 

Loading…
Cancelar
Guardar