Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesFrost authored Oct 11, 2016
1 parent 61d5da9 commit 7ddcf74
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,31 @@
# youtube-stream
Stream Youtube Livestream Chat in Nodejs.

```bash
npm install --save youtube-stream
```
## Usage
### ``` .connect(auth, accessToken, liveChatId, callback) ```
#### ```auth```
```json
{
"client_id" : "yourAppClientId",
"client_secret" : "yourAppClientSecret",
"redirect_uris" :
[
"yourAppRedirectUris"
]
}
```
#### ```accessToken```
Access token of the user you are collecting for.
#### ```liveChatId```
Live Chat Id of the live stream you want to collect.
#### ```callback```
Function invoked with ```(err, results)```.

Will be executed at regular intervals with new messages.

If ```err``` is set, the stream will stop.
## License
MIT

0 comments on commit 7ddcf74

Please sign in to comment.