Skip to content

Commit 0c2b76b

Browse files
committed
Add configschema.json and update README
1 parent fb597a0 commit 0c2b76b

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,17 @@ This bundle emits the `follower` event for a new follower, and registers the
2121
`latestFollower` replicant for the latest follower. These have a payload
2222
consisting of the [Twitch API Follower object](https://github.com/justintv/Twitch-API/blob/master/v3_resources/follows.md#get-usersuserfollowschannels).
2323

24+
## Sample Config
25+
26+
```json
27+
{
28+
"username": "twitchname",
29+
"pollInterval": 30
30+
}
31+
```
32+
33+
This can also be generated by the [nodecg-cli's](https://github.com/nodecg/nodecg-cli) `defaultconfig` command.
34+
2435
### Example
2536

2637
```javascript

configschema.json

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"type": "object",
3+
"properties": {
4+
"username": {
5+
"description": "Twitch.tv username",
6+
"type": "string",
7+
"default": ""
8+
},
9+
"pollInterval": {
10+
"description": "Interval to update followers (seconds)",
11+
"type": "integer",
12+
"default": 30
13+
}
14+
},
15+
"required": ["username"]
16+
}

0 commit comments

Comments
 (0)