From 685e905fbd136ae07ae036193f72a9553c4dfa05 Mon Sep 17 00:00:00 2001 From: William Mantly Date: Mon, 24 Aug 2020 17:05:58 -0400 Subject: [PATCH] docs --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ebc7361..19ff49c 100644 --- a/README.md +++ b/README.md @@ -116,6 +116,9 @@ list of peers to connect with. 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. +The `P2PSub` class provides `subscribe()`, `publish()`, `addPeer()` and +`removePeer()`. Please see the methods below for detailed usage. + #### Provided by `PubSub` class * `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. 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 passed as a single sting with a hostname and port, `'remotehost.com:7575'`,