diff --git a/README.md b/README.md index 7b83cd0..ef95e47 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ -# kcapp-sio-client -socket io client for kcapp +![kcapp logo](https://raw.githubusercontent.com/kcapp/frontend/master/public/images/logo.png) + +# sio-client +[socket io](https://socket.io/) client for consuming live events from [kcapp](https://github.com/kcapp/frontend) + + +## Usage +```javascript +var kcapp = require('kcapp-sio-client/kcapp')("", ); +kcapp.connect(() => { + kcapp.on('new_match', (data) => { + // New match started + }); + // Additional callbacks ... +}); +```