diff --git a/README.md b/README.md index f54eaa8..c493b1f 100644 --- a/README.md +++ b/README.md @@ -1 +1,43 @@ -# thingspeak-javascript \ No newline at end of file +cheerlights-javascript +===================== + +JavaScript client library for connecting to ThingSpeak ( https://thingspeak.com/ ) to get the latest color values for CheerLights ( https://cheerlights.com/ ). + +## Usage + +Add library to webpage: + +``` +<script src="cheerlights.js"></script> +``` + +Use getColor and set a callback: + +``` +CheerLights.getColor(callbackFunctionName); +``` + +## Property Values: color + +* color.htmlName +* color.hexValue + +## Color Values + +| htmlName | hexValue | +| --- | ----------- | +| red | #FF0000 | +| green | #008000 | +| blue | #0000FF | +| cyan | #00FFFF | +| white | #FFFFFF | +| oldlace | #FDF5E6 | +| purple | #800080 | +| magenta | #FF00FF | +| yellow | #FFFF00 | +| orange | #FFA500 | +| pink | #FFC0CB | + +## Examples + +See the [examples folder](https://github.com/cheerlights/cheerlights-javascript/tree/master/examples) for fully-working examples using this library.