Skip to content

Commit c9e7498

Browse files
committed
Add WebSocket Dependency;
Update readme to include installation instructions;
1 parent c2d61a3 commit c9e7498

2 files changed

Lines changed: 12 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
# Streamlabs Arduino Alerts [![Build Status](https://travis-ci.com/lucalas/StreamlabsArduinoAlerts.svg?branch=master)](https://travis-ci.com/lucalas/StreamlabsArduinoAlerts)
23
A work in progress library to connect to your Streamlabs account and catch all the Twitch events.
34

@@ -19,7 +20,16 @@ A work in progress library to connect to your Streamlabs account and catch all t
1920
- ATmega328 with enc28j60 (ATmega branch)
2021
- ATmega2560 with Ethernet Shield (ATmega branch)
2122
- ATmega2560 with enc28j60 (ATmega branch)
22-
-
23+
24+
## Add library
25+
Best thing is to use the Arduino Library Manager.
26+
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
32+
2333
## Methods
2434
#### connect(socket_token)
2535
Method to connect to Streamlabs server, required [socket token](https://streamlabs.readme.io/docs/sockettoken).

library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ paragraph=A work in progress library to connect to your Streamlabs account and c
77
category=Communication
88
url=https://github.com/lucalas/StreamlabsArduinoAlerts
99
architectures=*
10-
depends=SocketIoClient
10+
depends=SocketIoClient, WebSockets

0 commit comments

Comments
 (0)