From f42a2c52f3d4f1be1aef456e66e504c425c4bc49 Mon Sep 17 00:00:00 2001
From: Moritz Ruth <dev@moritz-ruth.de>
Date: Thu, 26 Dec 2019 15:43:27 +0100
Subject: [PATCH] Add README.md

---
 README.md    | 32 ++++++++++++++++++++++++++++++++
 package.json |  2 +-
 2 files changed, 33 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3edae26
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# node-enttec-open-dmx-usb
+> A Node.js library for sending DMX data through the
+>[Enttec Open DMX USB Interface](https://www.enttec.co.uk/en/product/controls/dmx-usb-interfaces/open-dmx-usb/)
+
+## Installation
+```bash
+yarn add node-enttec-open-dmx-usb
+# or
+npm install node-enttec-open-dmx-usb
+```
+
+## Usage
+All functions are documented using JSDoc and the code is not uglified, so feel free to [explore it](index.js).
+
+```js
+import { EnttecOpenDMXUSBDevice as DMXDevice } from "node-enttec-open-dmx-usb";
+
+(async () => {
+  const device = new DMXDevice(await DMXDevice.getFirstAvailableDevice());
+
+  device.setChannels({
+    1: 0xFF,
+    2: 0x44
+  });
+
+  // same as
+  device.setChannels([0xFF, 0x44]);
+
+  // same as
+  device.setChannels(Buffer.from([0xFF, 0x44]));
+})();
+```
diff --git a/package.json b/package.json
index bc4b7fe..850eb2b 100644
--- a/package.json
+++ b/package.json
@@ -11,7 +11,7 @@
     "build": "babel src --out-dir lib"
   },
   "files": [
-    "lib/*"
+    "index.js"
   ],
   "dependencies": {
     "@babel/preset-env": "^7.7.7",