wmantly/node-p2p-simple
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs

Browse Source
This commit is contained in:
William Mantly 2020-08-24 17:05:58 -04:00
parent e3e55b8a92
commit 685e905fbd
Signed by: wmantly
GPG Key ID: 186A8370EFF937CA
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -116,6 +116,9 @@ list of peers to connect with.
Methods are provided by either the `P2P` or `PubSub` classes. The `P2PSub` class Methods are provided by either the `P2P` or `PubSub` classes. The `P2PSub` class
is a mix of both classes and merges the Pub/Sub with p2p functions. is a mix of both classes and merges the Pub/Sub with p2p functions.
The `P2PSub` class provides `subscribe()`, `publish()`, `addPeer()` and
`removePeer()`. Please see the methods below for detailed usage.
#### Provided by `PubSub` class #### Provided by `PubSub` class
* `subscribe(topic, callback-function)` Sets a function to be called on `topic` * `subscribe(topic, callback-function)` Sets a function to be called on `topic`
@ -129,7 +132,7 @@ is a mix of both classes and merges the Pub/Sub with p2p functions.
* `topics` An instance attribute holding an Object on topics and bound callbacks. * `topics` An instance attribute holding an Object on topics and bound callbacks.
This is not exposed by the `P2PSub` class. This is not exposed by the `P2PSub` class.
#### Provided by `P2P` #### Provided by `P2P` class
* `addPeer(peer)` Adds a remote peer to the local peers connections. `peer` can * `addPeer(peer)` Adds a remote peer to the local peers connections. `peer` can
passed as a single sting with a hostname and port, `'remotehost.com:7575'`, passed as a single sting with a hostname and port, `'remotehost.com:7575'`,