📚 Add README.md

README.md

@@ -0,0 +1,31 @@
+# Unicorn Adapter
+
+Unicorn Adapter is a node library to help subscribe to events in the event processing platform [Unicorn](https://github.com/bptlab/Unicorn).
+
+## Getting started
+
+`npm install unicorn-adapter` to install the package
+```
+const UnicornAdapter = require('unicorn-adapter');
+
+let unicornAdapter = new UnicornAdapter("Your Unicorn Url", "Your callback Url", options);
+let uuid;
+
+unicornAdapter.subscribeToEvent('EventType').then(subscriptionId => {
+    uuid = subscriptionUuid;
+    console.log(`Subscription UUID: ${ subscriptionId }`);
+});
+
+unicornAdapter.unsubscribeFromEvent(uuid);
+```
+
+Available options:
+* `maxTries` - Number of retries
+
+## Authors
+
+* **Marius Lichtblau** - [mlichtblau](https://github.com/mlichtblau) - [lichtblau.io](https://lichtblau.io) - [@lichtblau](https://twitter.com/lichtblau)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details