diff --git a/.gitignore b/.gitignore index 6291fe2..50077fb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,3 @@ -node_modules lib-cov *.seed *.log @@ -13,5 +12,5 @@ pids logs results -npm-debug.log - +node_modules +npm-debug.log \ No newline at end of file diff --git a/README.md b/README.md index cbc67da..65a9c8c 100644 --- a/README.md +++ b/README.md @@ -1,80 +1,48 @@ -# webRTC.io -### [demo](http://webrtc.dennis.is/) -An abstraction layer for webRTC. Aim is to simplify the HTML5 web standard webRTC in a similar manner to socket.io w/ websockets. This project is still in an infantile stage, please send feature requests (or pulls!) to us as well as bug reports. +#webrtc.io-demo +============== -## What is webRTC? -webRTC is a new webstandard being developed for peer-to-peer communication on the web. This means that browsers will be able to send information, without sending information through the server. Server side this will reduce load dramatically. +You can have a look at the [demo](http://webrtc.dennis.is/) -Currently the webRTC standard is very focused on the video & audio aspects of the project. In the future (hopefully near future!) they will begin implementing the data channel, which will allow arbitrary data to be sent peer-to-peer. For now the webRTC team is focused on stabalizing and optimizing the video and audio channels. +##Instructions on how to setup the demo: -Unfortunately, a server (or two) will still be required for two reasons, The media for the page must be initially supplied, and the server, in conjunction with a [STUN server](http://en.wikipedia.org/wiki/STUN) (abstracted away by the webRTC.io library), is required to synchronize the connections. +Run in your terminal -## Browser Support -webRTC is supported in very few browsers. We recommend either chrome from either the dev channel or the canary release. -After installation, go to [About://flags](chrome://flags/). Enable +```bash +git clone git@github.com:webRTC/webrtc.io-demo.git ``` -Enable Media Source API on