Merge branch 'master' of github.com:kcapp/kcapp-sio-client

kcapp · Aug 30, 2021 · 4f298b8 · 4f298b8
2 parents a2022e3 + 788148a
commit 4f298b8
Showing 1 changed file with 16 additions and 2 deletions.
diff --git 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')("<server ip>", <server port>);
+kcapp.connect(() => {
+  kcapp.on('new_match', (data) => {
+    // New match started
+  });
+  // Additional callbacks ...
+});
+```