Initial implementation of the hash client

1 files changed, 19 insertions, 2 deletions

diff --git a/docs/getting_started.rst b/docs/getting_started.rst
index 68125fc..10b66c1 100644
--- a/docs/getting_started.rst
+++ b/docs/getting_started.rst
@@ -7,12 +7,29 @@ Basic Usage
 
 .. code-block:: python
 
-    from pymemcache.client import Client
+    from pymemcache.client.base import Client
 
     client = Client(('localhost', 11211))
     client.set('some_key', 'some_value')
     result = client.get('some_key')
 
+Using a memcached cluster
+-------------------------
+This will use a consistent hashing algorithm to choose which server to
+set/get the values from. It will also automatically rebalance depending
+on if a server goes down.
+
+.. code-block:: python
+
+    from pymemcache.client.hash import HashClient
+
+    client = HashClient([
+        ('127.0.0.1', 11211),
+        ('127.0.0.1', 11212)
+    ])
+    client.set('some_key', 'some value')
+    result = client.get('some_key')
+
 
 Serialization
 --------------
@@ -20,7 +37,7 @@ Serialization
 .. code-block:: python
 
      import json
-     from pymemcache.client import Client
+     from pymemcache.client.base import Client
 
      def json_serializer(key, value):
          if type(value) == str: