From b65306e3d54f6156b6470aea6922c2cf651bc18e Mon Sep 17 00:00:00 2001
From: Brandon Watson <wbrandon133@gmail.com>
Date: Sun, 20 Dec 2020 15:02:49 -0500
Subject: [PATCH] Update 'README.md'

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)

diff --git a/README.md b/README.md
index e69de29..f6de1b5 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,56 @@
+# homebridge-hue-chase
+
+Homebridge-hue-chase is a good way to add a little spice to your home lighting set up. This simple plugin will cycle the colors of any given hue lights.
+
+## Installation
+
+1. Clone the repository by running `git clone ssh://git@thebword.ddns.net:3122/watsonb8/homebridge-hue-chase.git`
+2. Run `npm install` to install required modules
+3. Run `npm run build` to build the module
+4. Run `npm link` or install globally to link this instance to your global homebridge instance
+
+> NOTE: Upon starting this plugin for the first time, you will be asked to press the sync button on your hue bridge
+
+## Configuration
+
+```
+{
+    "platform": "HueChase",
+    "ipAddress": "example.com",
+    "userName": "",
+    "clientKey": "",
+    "sequences": [
+    {
+        "name": "Play Sequence",
+        "transitionTime": 60000,
+        "matchAllLights": false,
+        "colors": ["#00e456", "#21adea", "#f14cfc", "#8c4cfc", "#e40098"],
+        "lights": ["Play left", "Play right"]
+    },
+    ]
+}
+```
+
+#### Platform
+
+- `ipAddress`: The ipaddres or host name of the hue hub
+
+- `userName`: The userName to use when authenticating with the hue hub
+
+> NOTE: This will be visible in the console upon first run of the platform
+
+- `clientKey`: This clientKey to use when authenticating with the hue hub
+
+> NOTE: This will be visible in the console upon first run of the platform
+
+- `sequences`: A list of sequence objects
+
+#### sequences
+
+- `name`: The name of the sequence. This will be the label of the enable switch
+
+- `transitionTime`: The amount of time in milliseconds it will take to transition from one color to the next
+
+- `colors`: A list hex colors
+
+- `lights`: The list of lights to use in the sequence