Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
CoffeeScript WebRTC Library
JavaScript CoffeeScript Ruby HTML

README.md

palava

palava is a WebRTC library for the browser. It enables you to create PeerConnections to other browsers. It works together with palava-machine, an open source WebRTC signaling server written in Ruby. To see it in action, checkout palava.tv (source).

Setup

palava is written in CoffeeScript. However, if you want to only use it (not hack on it), just use option 1 or 2 to include the compiled JavaScript version:

1) bower

$ bower install palava

This will install palava and its dependencies into a sub directory. Include all (palava, jQuery, eventEmitter) into your source file. For more information on bower, see bower.io.

2) JS bundle file

Include a direct link to the source file into your HTML:

<script src="https://path/to/palava.bundle.js" type="text/javascript"></script>

3) Browserify

See http://browserify.org

4) Sprockets/Middleman

Alternatively, you can directly include the coffee files into your project. See the palava portal for how it is done.

Documentation

The code is annotated and API documentation is generated by Codo.

A minimal example using JQuery is available to illustrate the basic workflow.

For a complex example using AngularJS see the palava-portal code:

Issues

Please report issues to the palava Repository.

Credits

LGPLv3. Part of the palava project.

Copyright (C) 2013 Jan Lelis       jan@signaling.io
Copyright (C) 2013 Marius Melzer   marius@signaling.io
Copyright (C) 2013 Stephan Thamm   thammi@chaossource.net
Copyright (C) 2013 Kilian Ulbrich  kilian@innovailable.eu

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
Something went wrong with that request. Please try again.