From 1d78eba2a40c991cde1d0b11480955316ed7e3dd Mon Sep 17 00:00:00 2001
From: Dustin Diaz <polvero@gmail.com>
Date: Sun, 23 Mar 2014 10:33:49 -0700
Subject: [PATCH] docs with examples

---
 README.md | 48 +++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 43 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index b52f594..625adab 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,54 @@
 ## Express rate-limitter
 Rate limiting middleware for Express applications built on redis
 
-
 ``` js
-var limitter = require('expa').limitter(app, client)
+var express = require('express')
+var app = express()
+var client = require('redis').createClient()
+
+var limitter = require('rate-limitter')(app, client)
 
 limitter({
-  path: '/like',
+  path: '/api/action',
   method: 'get',
-  lookup: ['req.user.id', 'req.connection.remoteAddress'],
-  total: 100,
+  lookup: ['connection.remoteAddress'],
+  // 150 requests per hour
+  total: 150,
   expire: 1000 * 60 * 60
 })
 
+app.get('/api/action', function (req, res) {
+  res.send(200, 'ok')
+})
+```
+
+### API options
+
+``` js
+limiter(options)
+```
+
+ - `path`: route path to the request
+ - `method`: http method. accepts `get`, `post`, `put`, `delete`, and of course Express' `all`
+ - `lookup`: value lookup on the request object. Can be a single value or array. See [examples](#examples) for common usages
+ - `total`: allowed number of requests before getting rate limited
+ - `expire`: amount of time in `ms` before the rate-limited is reset
+
+### Examples
+
+``` js
+// limit by IP address
+limitter({
+  lookup: 'connection.remoteAddress'
+})
+
+// or if you are behind a trusted proxy (like nginx)
+limiter({
+  lookup: 'headers.x-forwarded-for'
+})
+
+// by user (assuming a user is logged in with a valid id)
+limiter({
+  lookup: 'user.id'
+})
 ```