From 242f4f5cb48d0a88d1e7b42a59f3727b9ec37f9b Mon Sep 17 00:00:00 2001
From: Hans Scharler <hscharler@gmail.com>
Date: Thu, 9 Dec 2021 19:23:38 -0500
Subject: [PATCH] Update README with some documentation

---
 README.md | 44 +++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 43 insertions(+), 1 deletion(-)

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.