Document constructor options

libp2p / js-libp2p-websocket-star

libp2p-webrtc-star without webrtc. Just plain socket.io.

https://libp2p.io

39 stars 15 forks source link

Document constructor options #23

Open daviddias opened 7 years ago

daviddias commented 7 years ago

These https://github.com/libp2p/js-libp2p-websocket-star/blob/master/src/index.js#L28-L34 need to be documented on the README

mkg20001 commented 7 years ago

Readme.... Why not jsdocs inline?

mkg20001 commented 7 years ago

Added jsdocs everywhere. Sufficient?

harrshasri commented 6 years ago

@mkg20001 Hi, I'm using PubSub with websocket-star . Can you tell me the content routing mechanism?

Is the pubsub query transmitted via the signalling server? *If it is p2p does the query go through Flooding Technique?

mkg20001 commented 6 years ago

Is the pubsub query transmitted via the signalling server?

Yes. All traffic between peers that communicate using ws-star is transferred through the rendezvous server (the server has been renamed from signaling to rendezvous some time ago)

*If it is p2p does the query go through Flooding Technique?

I think yes

mkg20001 commented 6 years ago

Wrong button. Didn't want to close