Added readme

thelevicole · Mar 18, 2018 · cf1edba · cf1edba
1 parent eef5bf7
commit cf1edba
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,14 @@
-# lifx-desktop-app
+# LIFX Desktop App
+⚠️ Work in progress ⚠️
+A simple desktop application build on [Electron](https://electronjs.org/) using LIFX HTTP API.
+
+## Getting Started
+Clone and run the LIFX desktop application:
+
+```sh
+git clone git@github.com:thelevicole/lifx-desktop-app.git
+cd lifx-desktop-app
+npm install
+npm run start
+```
+