ssb-client - npm Package Compare versions

Comparing version 4.5.2 to 4.5.3

package.json

 {
   "name": "ssb-client",
-  "version": "4.5.2",
+  "version": "4.5.3",
   "description": "scuttlebot client",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -5,2 +5,6 @@ # ssb-client v2
 
+Create an rpc connection to an sbot running locally. 
+
+## example
+
 ```js
@@ -10,2 +14,3 @@ var ssbClient = require('ssb-client')
 // simplest usage, connect to localhost sbot
+// this will cb with an error if an sbot server is not running
 ssbClient(function (err, sbot) {
@@ -22,13 +27,40 @@ // ...
     port: 8008,        // optional, defaults to 8008
-    key: keys.id       // optional, defaults to keys.id
+    key: keys.id,      // optional, defaults to keys.id
+
+    caps: {
+        // random string for `appKey` in secret-handshake
+        shs: ''
+    },
+
+    // optional, muxrpc manifest. Defaults to ~/.ssb/manifest.json
+    manifest: {}       
+
   },
-  function (err, sbot) {
+  function (err, sbot, config) {
     // ...
   }
 )
+```
 
+### keys
+See [ssb-keys](https://github.com/ssbc/ssb-keys). The keys look like this:
+```js
+{
+    id: String,
+    public: String,
+    private: String,
+    curve: 'ed25519'
+}
 ```
 
+### caps
+`caps.shs` is a random string passed to [secret-handshake](https://github.com/auditdrivencrypto/secret-handshake#example). It determines which sbot you are able to connect to. It defaults to a magic string in this repo and also in [scuttlebot](https://github.com/ssbc/scuttlebot/blob/master/lib/ssb-cap.js)
+
+```js
+var appKey = new Buffer(opts.caps.shs, 'base64')
+```
+
+
 ## License
 
 MIT, Copyright 2015 Paul Frazee and Dominic Tarr

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9319

increased by10.41%

Number of lines in readme file

64

increased by100%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes