Mention PooledClient in the documentation (#285)

1 files changed, 14 insertions, 0 deletions

diff --git a/docs/getting_started.rst b/docs/getting_started.rst
index 25690e6..dc9ea26 100644
--- a/docs/getting_started.rst
+++ b/docs/getting_started.rst
@@ -24,6 +24,19 @@ passing the socket's path to the client's ``server`` parameter:
 
     client = Client('/var/run/memcached/memcached.sock')
 
+Using a client pool
+-------------------
+:class:`pymemcache.base.PooledClient`: is a thread-safe client pool that
+provides the same API as :class:`pymemcache.base.Client`:. It's useful in
+for cases when you want to maintain a pool of already-connected clients
+for improved performance.
+
+.. code-block:: python
+
+    from pymemcache.client.base import PooledClient
+
+    client = PooledClient(('127.0.0.1', 11211), max_pool_size=4)
+
 Using a memcached cluster
 -------------------------
 This will use a consistent hashing algorithm to choose which server to
@@ -53,6 +66,7 @@ To enable TLS in pymemcache, pass a valid TLS context to the client's
 ``tls_context`` parameter:
 
 .. code-block:: python
+
     import ssl
     from pymemcache.client.base import Client