Michelle Bu 11 жил өмнө
parent
commit
629993a165
1 өөрчлөгдсөн 48 нэмэгдсэн , 30 устгасан
  1. 48 30
      README.md

+ 48 - 30
README.md

@@ -1,57 +1,75 @@
 # PeerJS: Peer-to-peer data in the browser #
 # 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.
+PeerJS provides a complete, configurable, and easy-to-use peer-to-peer API built on top of WebRTC, supporting both WebRTC data channels and media streams.
 
 
 ##[http://peerjs.com](http://peerjs.com)
 ##[http://peerjs.com](http://peerjs.com)
 
 
 
 
 **Include the library**
 **Include the library**
 
 
-    <script src="http://cdn.peerjs.com/0/peer.js"></script>
+    <script src="http://cdn.peerjs.com/0.3/peer.js"></script>
 
 
 **Peer**
 **Peer**
 
 
-```html
-<script>
-  var peer = new Peer('someid', {key: 'apikey'});
-  peer.on('connection', function(conn) {
-    conn.on('data', function(data){
-      // Will print 'hi!'
-      console.log(data);
+```javascript
+var peer = new Peer('thing1', {key: 'myapikey'}); // You can omit the ID if you want to get a random one from the server.
+
+/** Data connections. */
+
+peer.on('connection', function(connection) {
+  connection.on('data', function(data){
+    // Will print 'hi!'
+    console.log(data);
+  });
+});
+
+/** Media calls. */
+
+var getUserMedia = navigator.getUserMedia || navigator.webkitGetUserMedia || navigator.mozGetUserMedia;
+peer.on('call', function(call) {
+  getUserMedia({video: true, audio: true}, function(stream) {
+    call.on('stream', function(stream) {
+      // Show stream in some <video> element.
     });
     });
+    call.answer(stream); // Answer any call with an A/V stream.
+  }, function(err) {
+    console.log(err);
   });
   });
-</script>
+});
 ```
 ```
 
 
 **Connecting peer**
 **Connecting peer**
 
 
-```html
-<script>
-  var peer = new Peer('anotherid', {key: 'apikey'});
-  var conn = peer.connect('someid');
-  conn.on('open', function(){
-    conn.send('hi!');
-  }); 
-</script>
-```
-
-### [Getting started](http://peerjs.com/start)
+```javascript
+var peer = new Peer('thing2', {key: 'myapikey'}); // You can omit the ID if you want to get a random one from the server.
 
 
-### [API reference](https://github.com/peers/peerjs/blob/master/docs/api.md)
+/** Data connections. */
 
 
-### [Browser compatibility status](http://peerjs.com/status)
+var connection = peer.connect('thing1');
+connection.on('open', function() {
+  connection.send('hi!'); // Send 'hi!' when the data connection opens.
+});
 
 
-### [PeerServer](https://github.com/peers/peerjs-server)
+/** Media calls. */
 
 
-### [Discuss PeerJS on our Google Group](https://groups.google.com/forum/?fromgroups#!forum/peerjs)
+var getUserMedia = navigator.getUserMedia || navigator.webkitGetUserMedia || navigator.mozGetUserMedia;
+getUserMedia({video: true, audio: true}, function(stream) {
+  var call = peer.call('thing1', stream);
+  call.on('stream', function(stream) {
+    // Show stream in some <video> element.
+  });
+}, function(err) {
+  console.log(err);
+});
 
 
-### [Changelog](https://github.com/peers/peerjs/blob/master/changelog.md)
+```
 
 
+### [Documentation](http://peerjs.com/docs)
 
 
-## In the future
+### [Browser compatibility status](http://peerjs.com/status)
 
 
-* Tests
-* Video/audio support (in progress)
+### [PeerServer](https://github.com/peers/peerjs-server)
 
 
+### [Discuss PeerJS on our Google Group](https://groups.google.com/forum/?fromgroups#!forum/peerjs)
 
 
+### [Changelog](https://github.com/peers/peerjs/blob/master/changelog.md)