From eda8ef324f66b0a01f2e91f51309cb09c1d91457 Mon Sep 17 00:00:00 2001
From: Shay Palachy <shaypal5@users.noreply.github.com>
Date: Sun, 28 Aug 2016 19:19:18 +0300
Subject: [PATCH] Update README.rst

---
 README.rst | 51 +++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 49 insertions(+), 2 deletions(-)

diff --git a/README.rst b/README.rst
index 5c6e1ea..eeaad20 100644
--- a/README.rst
+++ b/README.rst
@@ -1,4 +1,51 @@
-cachier
+Cachier
 =======
 
-Persistent, stale-free memoization decorators for Python.
+Persistent, stale-free cache / memoization decorators for Python.
+
+.. code-block:: python
+
+  from cachier import cachier
+  
+  @cachier()
+  def foo(arg1, arg2):
+    """Your function now has a persistent cache mapped by argument values!"""
+    return {'arg1': arg1, 'arg2': arg2}
+    
+
+Dependencies and Setup
+----------------------
+
+s3bp uses the following packages:
+
+* pymongo's `bson package`_
+* watchdog_
+
+You can install cachier using:
+
+.. code-block:: python
+
+    pip install cachier
+
+
+Use
+---
+
+Pickle-based Caching
+~~~~~~~~~~~~~~~~~~~~
+You can add a deafult, pickle-based persistent cache to your function by decorating int with the `cachier` decorator (notice the `()`!).
+
+.. code-block:: python
+
+  from cachier import cachier
+  
+  @cachier()
+  def foo(arg1, arg2):
+    """Your function now has a persistent cache mapped by argument values!"""
+    return {'arg1': arg1, 'arg2': arg2}
+
+
+
+.. links:
+.. _bson package: https://api.mongodb.com/python/current/api/bson/
+.. _watchdog: https://github.com/gorakhargosh/watchdog