Skip to content

Commit

Permalink
Merge branch 'development'
Browse files Browse the repository at this point in the history
  • Loading branch information
Thomas Gorissen committed Aug 14, 2014
2 parents dbbadfb + 38a13c2 commit 05c735f
Show file tree
Hide file tree
Showing 93 changed files with 39,108 additions and 6,359 deletions.
14 changes: 7 additions & 7 deletions Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,18 @@ module.exports = function (grunt) {
},
production: {
src: [
'node_modules/adapterjs/publish/adapter.debug.js',
'<%= source %>/skyway.js'
],
dest: '<%= production %>/skyway.debug.js'
},
complete: {
src: [
complete: {
src: [
'node_modules/socket.io-client/socket.io.js',
'node_modules/adapterjs/publish/adapter.debug.js',
'node_modules/adapterjs/source/adapter.js',
'<%= source %>/skyway.js'
],
dest: '<%= production %>/skyway.complete.js'
}
}
},

uglify: {
Expand All @@ -59,7 +58,7 @@ module.exports = function (grunt) {
production_min: {
files: {
'<%= production %>/skyway.min.js': ['<%= production %>/skyway.debug.js'],
'<%= production %>/skyway.complete.min.js': ['<%= production %>/skyway.complete.js']
'<%= production %>/skyway.complete.min.js': ['<%= production %>/skyway.complete.js']
}
}
},
Expand Down Expand Up @@ -136,7 +135,8 @@ module.exports = function (grunt) {
url: '<%= pkg.homepage %>',
options: {
paths: 'source/',
outdir: 'doc/'
outdir: 'doc/',
themedir: 'doc-style'
}
}
}
Expand Down
44 changes: 34 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
# SkywayJS

> WebRTC real-time video conversation library
> SkywayJS is an open-source client-side library for your web-browser that enables any website to easily leverage the capabilities of WebRTC and its direct data streaming powers between peers for audio/video conferencing or file transfer.
## Setup
You'll need a Temasys Developer Account and an API key to use this. [Register here to get your API key](https://developers.temasys.com.sg).

We've gone to great length to make this library work in as many browsers as possible. SkywayJS is build on top of [AdapterJS](https://github.com/Temasys/AdapterJS) and works with our [Temasys WebRTC Plugin](https://temasys.atlassian.net/wiki/display/TWPP/WebRTC+Plugins) even in Internet Explorer and Safari on Mac and PC.

- [Introducing SkywayJS](https://temasys.atlassian.net/wiki/display/TPD/Introducing+SkywayJS) - The complete documentation and API docs


#### Need help or want something changed?

Please read how you can find help, contribute and support us advancing SkywayJS on [our Github Page](http://temasys.github.io/support).


## How to setup this project

- Install or update to the latest version of node and npm
- Install `grunt-cli` (See: http://gruntjs.com/getting-started)
Expand All @@ -16,24 +28,36 @@
- Run `grunt jshint` to run jshint on its own.
- Run `grunt publish` to create production version in `publish` folder and generate the documentation in `doc` folder

## Folders

### demo
## What's included?

#### demo

Some demos to help with the development

### doc
#### doc

YUI Documentation for the Skyway object and its events
YUI documentation for the Skyway object and its events

### publish
#### doc-style

Template for our YUI documentation

#### publish

The production version of the library and a minified copy of it

### source
#### source

The skyway.js library development files

### tests
#### tests

Tape/Testling tests, currently work-in-progress


## License

[APACHE 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)


Tape tests
93 changes: 0 additions & 93 deletions demo/adapter.js

This file was deleted.

149 changes: 0 additions & 149 deletions demo/app-0.html

This file was deleted.

Loading

0 comments on commit 05c735f

Please sign in to comment.