From d443e7d58350c1ec39cc5f08f8779e5c24c6318c Mon Sep 17 00:00:00 2001 From: William Mantly Date: Mon, 24 Aug 2020 17:14:41 -0400 Subject: [PATCH] docs --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 19ff49c..e2b7323 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,9 @@ p2p.subscribe(\.\, (data)=> console.log(data)); ### P2PSub instance options +All of these are provided, and passed to the `P2P` class. `PubSub` takes no +instance variables. + `listenPort` Optional, type Number or String. Sets the incoming TCP port for the local peer to listen on. If this is left blank, the local peer will not accept incoming peers. Default is `undefined` @@ -156,4 +159,13 @@ The `P2PSub` class provides `subscribe()`, `publish()`, `addPeer()` and * `peerID` An instance attribute holding a String for the local `peerID`. This is randomly generated and is for internal use. This is not exposed by the - `P2PSub` class. \ No newline at end of file + `P2PSub` class. + +## Todo + +* Add timestamps to each message. +* Change the parsing of the message move `sentTo` in the prototype before + passing the class. +* Add optional TSL +* Internal ability to publish new peers across the network. +* Add config file for CLI mode.