Skip to content

Commit

Permalink
Update README. Refs #4
Browse files Browse the repository at this point in the history
  • Loading branch information
yhahn committed Jun 21, 2015
1 parent a5d2eb9 commit 5c4648d
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
[![Build Status](https://travis-ci.org/mapbox/tilelive-redis.png?branch=master)](https://travis-ci.org/mapbox/tilelive-redis)

redis-server version
--------------------

Required minimal/supported version of redis-server is 2.8.x

tilelive-redis
------------------
node-tilejson wrapping source for tilelive.
--------------
Module for adding a redis-based caching layer in front a [node-tilejson](https://github.com/mapbox/node-tilejson) tilelive source.

It wraps `node-tilejson`, providing a new source constructor with redis superpowers:

var options = {
mode: 'readthrough', // optional, cache mode either 'readthrough' or 'race'
Expand All @@ -18,6 +15,10 @@ node-tilejson wrapping source for tilelive.

new TileJSON( ... )

### Requirements

Required minimal/supported version of redis-server is 2.8.x

### Cache modes

Two modes for caching are available.
Expand Down

0 comments on commit 5c4648d

Please sign in to comment.