From 8bc160abba757c8bdf01044f2e57dcd59ec6206b Mon Sep 17 00:00:00 2001
From: Danny Wilson <danny@prime.vc>
Date: Tue, 12 Apr 2016 12:49:15 +0200
Subject: [PATCH] Add README.md

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..364ba6a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Pubsure Reader
+
+A simple [Containium](https://github.com/containium/containium) app serving the [pubsure-ws](https://github.com/touch/pubsure-ws) library.
+Requires `http-kit` system for websockets.
+
+
+## Usage
+
+### Configuration and deployment.
+
+Deploy just as any other Containium Ring application.
+Example deployment descriptor:
+
+```
+{:file "path/to/pubsure-reader", {:ring {:context-path "/pubsure", :host-regex "example.com"}, :swappable? true}}
+```
+
+
+## License
+
+Mozilla Public License 2.0