https://github.com/h2non/webmotely.js
Webmotely JavaScript client
https://github.com/h2non/webmotely.js
Last synced: 5 months ago
JSON representation
Webmotely JavaScript client
- Host: GitHub
- URL: https://github.com/h2non/webmotely.js
- Owner: h2non
- License: mit
- Created: 2014-07-19T11:40:53.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2014-07-21T11:35:18.000Z (almost 11 years ago)
- Last Synced: 2024-10-18T11:25:49.083Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 328 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# webmotely
> This project is a proof of concept
**Webmotely** JavaScript client to enable remote control for Web applications
To see it in action, visit the [demo](http://webmotely.github.io/demo) page
## Installation
#### Browser
Via Bower package manager
```bash
bower install webmotely --save
```
Or loading the script remotely
```html
```
### Environments
It [works](http://kangax.github.io/compat-table/es5/) in any ES5 compliant engine
- Chrome >= 5
- Firefox >= 3
- Safari >= 5
- Opera >= 12
- IE >= 9
## Basic usage
```js
var webmotely = require('webmotely')
```
```js
webmotely.start({
server: 'ws://my.server.net:3000'
})
```
## API
## Development
Only [node.js](http://nodejs.org) is required for development
Clone/fork this repository
```
$ git clone https://github.com/webmotely/webmotely.js.git && cd webmotely.js
```
Install package dependencies
```
$ npm install
```
Compile code
```
$ make compile
```
Run tests
```
$ make test
```
Browser sources bundle generation
```
$ make browser
```
Release a new version
```
$ make release
```
## License
[MIT](http://opensource.org/licenses/MIT) - Tomas Aparicio
[travis]: http://travis-ci.org/webmotely/webmotely.js
[npm]: http://npmjs.org/package/webmotely.js