-
Notifications
You must be signed in to change notification settings - Fork 118
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update links, add README to sails.io.js-dist, and clean up some TODOs…
… that really ought to be FUTUREs (in the interest of reserving TODO for immediate things that need doing)
- Loading branch information
1 parent
485f3cd
commit a7fb853
Showing
5 changed files
with
59 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# sails.io.js-dist | ||
|
||
This is the JavaScript SDK for communicating with Sails via sockets. Specifically, it is the distribution for web browsers, and the release that is bundled in new Sails apps by default. | ||
|
||
|
||
## Compatibility | ||
|
||
Before using this package directly, be sure that you're using the same version as the dependency in your version of Sails's [sails-generate](https://npmjs.com/package/sails-generate)'s package.json file. | ||
|
||
> Prior to Sails v1, instead of `sails-generate`, this was in the `sails-generate-sails.io.js` dependency, | ||
> which was itself a dependency of `sails-generate-frontend`, which was itself a depenency of `sails-generate`, | ||
> which was itself a dependency of `sails. (You can see why we changed it!) | ||
> | ||
> Anyway, if you're using <=Sails v0.12, check the dependency version in the package.json file of [sails-generate-sails.io.js](https://npmjs.com/package/sails-generate-sails.io.js). | ||
|
||
This package is _always_ released under the same version string as [`sails.io.js`](https://npmjs.com/package/sails.io.js), the Node.js distribution. (It is published automatically when `sails.io.js` is published.) | ||
|
||
|
||
## Help | ||
|
||
If you have questions or are having trouble, click [here](http://sailsjs.com/support). | ||
|
||
|
||
## Bugs [![NPM version](https://badge.fury.io/js/sails.io.js-dist.svg)](http://npmjs.com/package/sails.io.js-dist) | ||
|
||
To report a bug, [click here](http://sailsjs.com/bugs). | ||
|
||
|
||
## Contributing [![Build Status](https://travis-ci.org/balderdashy/sails.io.js-dist.svg?branch=master)](https://travis-ci.org/balderdashy/sails.io.js-dist) | ||
|
||
Please observe the guidelines and conventions laid out in the [Sails project contribution guide](http://sailsjs.com/contribute) when opening issues or submitting pull requests. | ||
|
||
[![NPM](https://nodei.co/npm/sails.io.js-dist.png?downloads=true)](http://npmjs.com/package/sails.io.js-dist) | ||
|
||
|
||
## License | ||
|
||
This package is part of the [Sails framework](http://sailsjs.com), and is free and open-source under the [MIT License](http://sailsjs.com/license). | ||
|
||
|
||
![image_squidhome@2x.png](http://i.imgur.com/RIvu9.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,16 @@ | ||
{ | ||
"name": "sails.io.js-dist", | ||
"version": "1.1.0", | ||
"description": "Distribution version of sails.io.js for browsers, including bundled socket.io-client", | ||
"description": "Distribution version of sails.io.js for browsers, including bundled socket.io-client.", | ||
"main": "sails.io.js", | ||
"repository": { | ||
"type": "git", | ||
"url": "git://github.com/balderdashy/sails.io.js.git" | ||
}, | ||
"author": "Mike McNeil <@mikermcneil> (http://balderdash.co/)", | ||
"author": "Mike McNeil <@mikermcneil> (http://mikermcneil.com/)", | ||
"license": "MIT", | ||
"bugs": { | ||
"url": "https://github.com/balderdashy/sails.io.js/issues" | ||
"url": "https://github.com/balderdashy/sails/issues" | ||
}, | ||
"homepage": "https://github.com/balderdashy/sails.io.js" | ||
"homepage": "http://sailsjs.com/documentation/reference/web-sockets/socket-client" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters