Added some more content in the README.

moscajs · Dec 31, 2015 · 2e2e882 · 2e2e882
1 parent ee00ef3
commit 2e2e882
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,23 @@
 
 See [aedes-persistence][persistence] for the full API, and [Aedes][aedes] for usage.
 
+## Install
+
+```
+npm i aedes aedes-persistence-redis --save
+```
+
+## API
+
+<a name="constructor"></a>
+### aedesPersistenceRedis([opts])
+
+Creates a new instance of aedes-persistence-redis.
+It takes all the same options of [ioredis](http://npm.im/ioredis),
+which is used internally to connect to Redis.
+
+This constructor creates two connections to Redis.
+
 ## License
 
 MIT