Commit 0af731944b36c4896f401bf8a54712680ef63ce7
document config
Dominic Tarr committed on 7/20/2017, 10:14:27 AMParent: 79475b914bb4109c2c52e9c4fc8569b0e48e87df
Files changed
| README.md | changed |
| README.md | |||
|---|---|---|---|
| @@ -57,15 +57,26 @@ | |||
| 57 | 57 … | ||
| 58 | 58 … | if the type is `channel` it gets posted in a irc channel publically, | |
| 59 | 59 … | if it's a user, it's posted as a direct message to them. | |
| 60 | 60 … | ||
| 61 … | +## config | ||
| 62 … | + | ||
| 63 … | +`ssb-irc` supports the following configuration options | ||
| 64 … | + | ||
| 65 … | +``` | ||
| 66 … | +"irc": { | ||
| 67 … | + //domain where your ssb-viewer is hosted. | ||
| 68 … | + "viewer": <http://yourhost.com> || http://viewer.scuttlebot.io, | ||
| 69 … | + "host": <irc_host> || "irc.freenode.net", | ||
| 70 … | + "port:" <irc_port> || 6667, | ||
| 71 … | + "name": <name_of_ircbot> || "ssbbot" | ||
| 72 … | +} | ||
| 73 … | +``` | ||
| 74 … | + | ||
| 61 | 75 … | ## more ideas | |
| 62 | 76 … | ||
| 63 | 77 … | also give out ssb invites to people on irc (and set up notifications for them too, obviously) | |
| 64 | 78 … | ||
| 65 | 79 … | ## License | |
| 66 | 80 … | ||
| 67 | 81 … | MIT | |
| 68 | 82 … | ||
| 69 | - | ||
| 70 | - | ||
| 71 | - | ||
Built with git-ssb-web