Skip to content

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vizanto committed Apr 12, 2016
1 parent aa55cec commit 8bc160a
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 8bc160a

Please sign in to comment.