bug in docs on peerjs.com #1352
Description
Please, check for existing issues to avoid duplicates.
- No similar issues found.
What happened?
this costed me HOURS to find out the tutorial on the front page of peerjs.com has a bug:
IT SHOULD READ conn.peer
How can we reproduce the issue?
on peerjs.com IT SHOULD READ conn.peer instead of
Data connections
Connect
var conn = peer.connect('another-peers-id');
// on open will be launch when you successfully connect to PeerServer
conn.on('open', function(){
// HERE YOU HAVE CONN.ID <<<<<<<<<
conn.send('hi!');
});
What do you expected to happen?
i have forked the repo and added a clarification comment to readme.md,
but github wont let me pull request to your repo. likely cause I have just registered here to report this (I am on codeberg)
-
please pull/merge the clarified readme.md from
https://github.com/magpts/peerjs.git -
update the front page on peerjs.com to to contain a comment line something like
Data connections Connect var conn = peer.connect('another-peers-id'); // on open will be launch when you successfully connect to PeerServer conn.on('open', function(){ // ID of the other end is conn.peer <<<<<<<<< conn.send('hi!'); });
Environment setup
- OS: -
- Platform: js
- Browser: ff
Is this a regression?
No response
Anything else?
No response