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:14:41 -04:00
parent 685e905fbd
commit d443e7d583
Signed by: wmantly
GPG Key ID: 186A8370EFF937CA
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -83,6 +83,9 @@ p2p.subscribe(\.\, (data)=> console.log(data));
### P2PSub instance options ### 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 `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 local peer to listen on. If this is left blank, the local peer will not accept
incoming peers. Default is `undefined` 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 * `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 is randomly generated and is for internal use. This is not exposed by the
`P2PSub` class. `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.