Skip to content

Commit c9c2ee4

Browse files
committed
Updated version and readme
1 parent 3807d96 commit c9c2ee4

File tree

2 files changed

+15
-11
lines changed

2 files changed

+15
-11
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11

22
# Streamlabs Arduino Alerts [![Build Status](https://travis-ci.com/lucalas/StreamlabsArduinoAlerts.svg?branch=master)](https://travis-ci.com/lucalas/StreamlabsArduinoAlerts)
3-
A work in progress library to connect to your Streamlabs account and catch all the Twitch events.
3+
Library to connect to your Streamlabs account and catch all the `Twitch` events.
44

5-
## Twitch event catchable
5+
## Twitch catchable events
66

77
- Follow
88
- Subscription
9+
- Resubscription
910
- Donation
1011
- Raid
1112
- Host
@@ -24,18 +25,18 @@ A work in progress library to connect to your Streamlabs account and catch all t
2425
## Add library
2526
Best thing is to use the Arduino Library Manager.
2627

27-
Go to Sketch > Include Library > Manage Libraries.
28-
Install WebSockets by Markus Sattler
29-
Install SocketIoClient
30-
Install StreamlabsArduinoAlerts
31-
Select Sketch > Include Library > StreamlabsArduinoAlerts
28+
- Go to Sketch > Include Library > Manage Libraries.
29+
- Install `WebSockets` by Markus Sattler
30+
- Install `StreamlabsArduinoAlerts`
31+
- Select Sketch > Include Library > StreamlabsArduinoAlerts
3232

3333
## Methods
3434
#### connect(socket_token)
35-
Method to connect to Streamlabs server, required [socket token](https://streamlabs.readme.io/docs/sockettoken).
35+
Method to connect to Streamlabs server, required [socket token](#get-streamlabs-socket-token).
3636

3737
#### followTwitchEvent(callback)
3838
#### subscriptionsTwitchEvent(callback)
39+
#### resubscriptionsTwitchEvent(callback)
3940
#### hostTwitchEvent(callback)
4041
#### bitsTwitchEvent(callback)
4142
#### raidsTwitchEvent(callback)
@@ -68,5 +69,8 @@ void loop() {
6869

6970
Event result documentation can be found on Streamlabs WebSite [HERE](https://dev.streamlabs.com/docs/socket-api)
7071

72+
## Get Streamlabs Socket Token
73+
You can find yours at https://streamlabs.com/dashboard#/apisettings under "API TOKENS" then "Your Socket API Token". This token is bound to the account that you are logged in with. If you need to access the alerts of a streamer, ask them to provide you with a token from the above location.
74+
7175
### Issues ###
7276
Submit issues to: https://github.com/lucalas/StreamlabsArduinoAlerts/issues

library.properties

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
name=StreamlabsArduinoAlerts
2-
version=0.1
2+
version=1.0
33
author=Luca Taddeo
44
maintainer=Luca Taddeo
55
sentence=Library to get Streamlabs event from Twitch
6-
paragraph=A work in progress library to connect to your Streamlabs account and catch all the Twitch events.
6+
paragraph=Library to connect to your Streamlabs account and catch all the Twitch events.
77
category=Communication
88
url=https://github.com/lucalas/StreamlabsArduinoAlerts
99
architectures=*
10-
depends=SocketIoClient, WebSockets
10+
depends=WebSockets

0 commit comments

Comments
 (0)