Merge branch 'master' of https://github.com/insanj/rocker

README.md

@@ -1,2 +1,31 @@
-# rocker
-🔘 philips hue rocker
+# [rocker](https://insanj.github.io/rocker/)
+
+🔘 philips hue rocker. intricate controls for philips hue lights using a free webapp built in vanilla jquery.
+
+## Usage
+
+- Open `rocker/index.html` locally and follow the webapp instructions to authenticate and control your bridge from home.
+
+or
+
+- Open `https://insanj.github.io/rocker/` remotely and follow the webapp instructions to oauth and control your bridge anywhere.
+
+> Note: You will need to be near your bridge for the initial setup, which requires tapping the button on top to start.
+
+## Background
+
+Rocker is an app developed on the Philips Hue Web API. [Documentation available online](https://developers.meethue.com/documentation/getting-started) and an easy debug terminal is accessible locally using the bridge format:
+
+```
+http://<BRIDGE_URL>/debug/clip.html
+```
+
+Using an already-existing app can greatly help debugging issues and getting your Bridge's IP Address, such as: [Huemote for iOS](http://huemoteapp.com/), [Huetro for Windows](https://www.microsoft.com/en-us/p/huetro-for-hue/9wzdncrfjj3t), [Huegasm for Chrome](https://chrome.google.com/webstore/detail/huegasm-for-philips-hue-l/mbjanbdhcpohhfecjgbdpcfhnnbofooj), and so on.
+
+## License
+
+[See LICENSE](LICENSE). Copyright 2018 Julian Weiss.
+
+## Authors
+
+Julian (insanj) Weiss. https://github.com/insanj