README.md in routemaster-drain-1.0.0 vs README.md in routemaster-drain-1.0.1

- old
+ new

@@ -1,15 +1,15 @@ # routemaster-drain A Rack-based event receiver for the [Routemaster](https://github.com/HouseTrip/routemaster) event bus. -![Version](https://badge.fury.io/rb/routemaster-drain.svg) +[![Version](https://badge.fury.io/rb/routemaster-drain.svg)](https://rubygems.org/gems/routemaster-drain)   -![Build](https://travis-ci.org/HouseTrip/routemaster-drain.svg?branch=master) +[![Build](https://travis-ci.org/HouseTrip/routemaster-drain.svg?branch=master)](https://travis-ci.org/HouseTrip/routemaster-drain)   -[![](http://img.shields.io/badge/API%20docs-rubydoc.info-blue.svg)](http://rubydoc.info/github/HouseTrip/routemaster-drain/frames/file/README.md) +[![Docs](http://img.shields.io/badge/API%20docs-rubydoc.info-blue.svg)](http://rubydoc.info/github/HouseTrip/routemaster-drain/frames/file/README.md) `routemaster-drain` is a collection of Rack middleware to receive and parse Routemaster events, filter them, and preemptively cache the corresponding resources. @@ -43,12 +43,17 @@ **Configuration** This gem is configured through the environment, making 12factor compliance easier. +Required: + - `ROUTEMASTER_DRAIN_TOKENS`: a comma-separated list of valid authentication tokens, used by Routemaster to send you events. + +Optional: + - `ROUTEMASTER_DRAIN_REDIS`: the URL of the Redis instance used for filtering and dirty mapping. Required if you use either feature, ignored otherwise. A namespace can be specified. Example: `redis://user:s3cr3t@myhost:1234/12/ns`. - `ROUTEMASTER_CACHE_REDIS`: the URL of the Redis instance used for caching. @@ -175,10 +180,10 @@ For this purpose, use `Routemaster::Drain::Caching`: ```ruby require 'routemaster/drain/machine' -$app = Routemaster::Drain:Caching.new +$app = Routemaster::Drain::Caching.new ``` And mount it as usual: ```ruby