No Description

Michelle Bu ff51410c22 specificity 12 years ago
bin ec5ec82e8e socket abstraction 12 years ago
deps 8929d1beca googlegroup to readme 12 years ago
dist 9094c57f00 serialization and metadata as option 12 years ago
docs ff51410c22 specificity 12 years ago
examples d5dacd55d5 remove old p2pchat for now 12 years ago
lib 9094c57f00 serialization and metadata as option 12 years ago
.gitignore 55c39fa795 removed demo folder 12 years ago
.gitmodules f6741b727f module update 12 years ago
LICENSE 332f2d486f license 12 years ago
Makefile ea9a3207cb submodules, gitignore, make 12 years ago
README.md 134491924b new readme 12 years ago
package.json 60adf874f1 fix package.json 12 years ago

README.md

PeerJS: Peer-to-peer data in the browser

PeerJS provides a complete, configurable, and easy-to-use peer-to-peer data API built on top of WebRTC.
Each peer simply provides a identifier with which other peers using the same API key can connect.

##http://peerjs.com

Include the library

<script src="http://cdn.peerjs.com/0/peer.js"></script>

Peer

<script>
  var peer = new Peer('someid', {key: 'apikey'});
  peer.on('connection', function(conn) {
    conn.on('data', function(data){
      // Will print 'hi!'
      console.log(data);
    });
  });
</script>

Connecting peer

<script>
  var peer = new Peer('anotherid', {key: 'apikey'});
  var conn = peer.connect('someid');
  conn.on('open', function(){
    conn.send('hi!');
  }); 
</script>

Getting started

API reference

Browser compatibility status

PeerServer

Discuss PeerJS on our Google Group

In the future

  • Tests
  • Firefox support
  • Stream API
  • Video/audio support