From 5c4648ddfcd36f295789c22994f3ae051b2ffbad Mon Sep 17 00:00:00 2001 From: Young Hahn Date: Sun, 21 Jun 2015 17:32:54 -0400 Subject: [PATCH] Update README. Refs #4 --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 98e1eda..09c79dc 100644 --- a/README.md +++ b/README.md @@ -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' @@ -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.