sbrl-github
/
SnoozeSquad
mirror of https://github.com/sbrl/SnoozeSquad.git
1
0
Fork 0
Code

Add development information to README

This commit is contained in:
Starbeamrainbowlabs 2016-05-28 16:56:37 +01:00
parent f6e1e201dd
commit 61f922f7fe
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -39,7 +39,16 @@ You can pass Snooze Squad a number of options. Below is an explanation of each:
* attributeName - The name of the attribute that we should copy over to wake image up.
* updateInterval - The maximum interval at which we should update. Helps to prevent lag.
## Development
Snooze Squad development isn't too complicated either. You'll need [Node.js] and make installed if you want to build / minify Snooze Squad.
Note that if you submit pull requests, it would be helpful if you _didn't_ minify the file yourself if there's alreayd a pull request waiting. That just gets messy.
### Setup
If you're on linux, just run `make setup` in the current directory. If not (or you're on a machine without `sudo` - how odd!), just run `npm install uglify-js-harmony --global` instead.
### Minification
Just run `make` in the current directory.
## License
Snooze Squad is licensed under the MIT license. See the [LICENSE](https://github.com/sbrl/SnoozeSquad/blob/master/LICENSE) file in this repository.