Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/goliatone/windowsocket

WebSocket compliant library to provide a push/sub to a wrapper layer: WebView TCP
https://github.com/goliatone/windowsocket

Last synced: 4 days ago
JSON representation

WebSocket compliant library to provide a push/sub to a wrapper layer: WebView TCP

Awesome Lists containing this project

README

        

# WindowSocket

[![Build Status](https://secure.travis-ci.org/goliatone/windowsocket.png)](http://travis-ci.org/goliatone/windowsocket)

Messaging class implementing WebSocket API.

## Getting Started
Download the [production version][min] or the [development version][max].

[min]: https://raw.github.com/goliatone/windowsocket/master/dist/windowsocket.min.js
[max]: https://raw.github.com/goliatone/windowsocket/master/dist/windowsocket.js

## Development
`npm install && bower install`

If you need to `sudo` the `npm` command, you can try to:

```terminal
sudo chown $(whoami) ~/.npm
sudo chown $(whoami) /usr/local/share/npm/bin
sudo chown -R $(whoami) /usr/local/lib/node_modules
```

If you bump versions, remember to update:
- package.json
- bower.json
- component.json
- etc.

## Bower
>Bower is a package manager for the web. It offers a generic, unopinionated solution to the problem of front-end package management, while exposing the package dependency model via an API that can be consumed by a more opinionated build stack. There are no system wide dependencies, no dependencies are shared between different apps, and the dependency tree is flat.

To register windowsocket in the [bower](http://bower.io/) [registry](http://sindresorhus.com/bower-components/):
`bower register windowsocket git://github.com/goliatone/windowsocket.git`

Then, make sure to tag your module:

`git tag -a v0.1.0 -m "Initial release."`

And push it:

`git push --tags`

## Travis
In order to enable Travis for this specific project, you need to do so on your Travi's [profile](https://travis-ci.org/profile). Look for the entry `goliatone/windowsocket`, activate, and sync.

## Documentation
_(Coming soon)_

## Examples
_(Coming soon)_

## Release History
_(Nothing yet)_