@geckos.io/client - npm Package Compare versions

Comparing version 0.0.6 to 0.0.7

package.json

 {
   "name": "@geckos.io/client",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Real-time client/server communication over UDP using WebRTC and Node.js",
@@ -44,4 +44,4 @@ "main": "lib/index.js",
   "dependencies": {
-    "@geckos.io/common": "0.0.5"
+    "@geckos.io/common": "0.0.6"
   }
 }

README.md

@@ -13,6 +13,8 @@ <a href="http://geckos.io">
 
-Real-time client/server communication over UDP using WebRTC and Node.js.
+Real-time client/server communication over UDP using **WebRTC** and **Node.js**.
 
-Read the [documentation](https://github.com/geckosio/geckos.io) for more information.
+This framework fits perfectly with your next **HTML5 real-time multiplayer games** or chat app.
 
+Read the [**documentation**](https://github.com/geckosio/geckos.io) for more information.
+
 ## Install
@@ -23,1 +25,25 @@
 ```
+
+## Use
+
+```js
+import geckos from '@geckos.io/client'
+
+// or add a minified version to your index.html file
+// https://github.com/geckosio/geckos.io/tree/master/bundles/versions
+
+const channel = geckos()
+
+channel.onConnect(error => {
+  if (error) {
+    console.error(error.message)
+    return
+  }
+
+  channel.on('chat message', data => {
+    console.log(`You got the message ${data}`)
+  })
+
+  channel.emit('chat message', 'a short message sent to the server')
+})
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

34761

increased by1.68%

Number of lines in readme file

48

increased by118.18%

Dependency changes

• + [e-mail]/common@0.0.6(transitive)

• - [e-mail]/common@0.0.5(transitive)

• [e-mail]/common@0.0.6