From: Daniel Greenfeld <pydanny@gmail.com>
Date: Sat, 17 May 2014 23:18:08 +0000 (-0700)
Subject: Update the readme
X-Git-Tag: 0.1.1~4
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=c4a5c20b6adb28baddeb1ad79d3e4bfbc9279f27;p=cached-property.git

Update the readme
---

diff --git a/README.rst b/README.rst
index 763015e..4bf44bc 100644
--- a/README.rst
+++ b/README.rst
@@ -17,7 +17,76 @@ A cached-property for decorating methods in classes.
 * Free software: BSD license
 * Documentation: http://cached-property.rtfd.org.
 
-Features
+Why?
+-----
+
+* Makes caching of time or computational expensive properties quick and easy.
+* Because I got tired of copy/pasting this code from non-web project to non-web project.
+* I needed something really simple that worked in Python 2 and 3.
+
+How to use it
+--------------
+
+Define a class with an expensive property. Every time you stay there the 
+price goes up by $50. I
+
+.. code-block:: python
+
+    class Monopoly(object):
+
+        def __init__(self):
+            self.boardwalk_price = 500
+
+        @property
+        def boardwalk(self):
+            # In reality, this might represent a database call or time 
+            # intensive task like calling a third-party API.
+            self.boardwalk_price += 50
+            return self.boardwalk_price
+
+Now run it:
+
+.. code-block:: python
+
+    >>> m = Monopoly()
+    >>> m.boardwalk
+    550
+    >>> m.boardwalk
+    600
+
+Let's convert the boardwalk property into a `cached_property`.
+
+
+.. code-block:: python
+
+    from cached_property import cached_property
+
+    class Monopoly(object):
+
+        def __init__(self):
+            self.boardwalk_price = 500
+
+        @property
+        def cached_property(self):
+            # Again, this is a silly example. Don't worry about it, this is
+            #   just an example for clarity.
+            self.boardwalk_price += 50
+            return self.boardwalk_price
+
+Now when we run it the price stays at $550. Why? because it's cached!:
+
+.. code-block:: python
+
+    >>> m = Monopoly()
+    >>> m.boardwalk
+    550
+    >>> m.boardwalk
+    550
+    >>> m.boardwalk
+    550
+
+Credits
 --------
 
-* TODO
\ No newline at end of file
+* Django, Werkzueg, Bottle, and Zope for having their own implementations. This package uses the Django version.
+* Reinout Van Rees for pointing out the cached_property decorator to me.