Add initial implementation, unit tests

1 files changed, 38 insertions, 7 deletions

diff --git a/README.rst b/README.rst
index df10ac4..afe3375 100644
--- a/README.rst
+++ b/README.rst
@@ -1,11 +1,26 @@
 cachetools
 ========================================================================
 
-This module...
+This module provides various memoizing collections and function
+decorators, including a variant of the Python 3 functools.lru_cache_
+decorator.
+
+.. note::
+
+    This module is in early pre-alpha, and not fit for *any* purpose
+    (yet).
 
 .. code-block:: pycon
 
-    >>> from cachetools import LRUCache, LFUCache
+    >>> from cachetools import LRUCache
+    >>> cache = LRUCache(maxsize=16)
+    >>> cache['test'] = 1
+    >>> cache.info()
+    CacheInfo(hits=0, misses=0, maxsize=16, currsize=1)
+    >>> cache['test']
+    1
+    >>> cache.info()
+    CacheInfo(hits=1, misses=0, maxsize=16, currsize=1)
 
 
 Installation
@@ -19,11 +34,10 @@ Install cachetools using pip::
 Project Resources
 ------------------------------------------------------------------------
 
-- `Documentation <http://pythonhosted.org/cachetools/>`_
-- `Issue Tracker <https://github.com/tkem/cachetools/issues>`_
-- `Source Code <https://github.com/tkem/cachetools>`_
-- `Change Log <http://raw.github.com/tkem/cachetools/master/Changes>`_
-
+- `Documentation`_
+- `Issue Tracker`_
+- `Source Code`_
+- `Change Log`_
 
 .. image:: https://pypip.in/v/cachetools/badge.png
     :target: https://pypi.python.org/pypi/cachetools/
@@ -32,3 +46,20 @@ Project Resources
 .. image:: https://pypip.in/d/cachetools/badge.png
     :target: https://pypi.python.org/pypi/cachetools/
     :alt: Number of PyPI downloads
+
+
+License
+------------------------------------------------------------------------
+
+cachetools is Copyright 2014 Thomas Kemmer.
+
+Licensed under the `MIT License`_.
+
+
+.. _functools.lru_cache: http://docs.python.org/3.4/library/functools.html#functools.lru_cache
+
+.. _Documentation: http://pythonhosted.org/cachetools/
+.. _Source Code: https://github.com/tkem/cachetools/
+.. _Issue Tracker: https://github.com/tkem/cachetools/issues/
+.. _Change Log: https://raw.github.com/tkem/cachetools/master/Changes
+.. _MIT License: http://opensource.org/licenses/MIT