roomrtc
Version:
RoomRTC enables quick development of webRTC
38 lines (28 loc) • 1.23 kB
Markdown
RoomRTC
================
RoomRTC enables quick development of webRTC
[](https://www.npmjs.com/package/roomrtc)
**Status**: `v1.0.0` coming soon.
Installation In A Nutshell
===========================
I'd recommend using a package manager if you aren't already and here are the relevant instructions for installing RoomRTC from a number of popular options:
1. Install [Node.js](http://nodejs.org/), [Bower](http://bower.io/)
2. Download using package manager
* **npm**: `npm install roomrtc --save`
* **bower**: `bower install roomrtc --save`
3. Include the library
* Server: `var roomrtc = require('roomrtc')`
* Client: `<script src="https://roomrtc.github.io/latest/roomrtc.min.js"></script>`
Website and documentation
=========================
* Visit [roomrtc.github.io](https://roomrtc.github.io) to explore demos and examples.
* Demo [demo.roomrtc.com](https://demo.roomrtc.com)
Run roomrtc as your own server:
* Clone repo: `git clone https://github.com/vunb/roomrtc.git`
* Change dir: `cd roomrtc`
* Install deps: `npm install`
* Start server: `npm run demo`
* Open browser: `http://localhost:8123/?myroom`
License
========
MIT