Skip to content

Commit 4792320

Browse files
committed
Improve formatting in README
This change converts the broken list items into separate headings.
1 parent 1bb2f77 commit 4792320

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

README.rst

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@ Amazon ElastiCache backend for Django
22
=====================================
33

44
Simple Django cache backend for Amazon ElastiCache (memcached based). It uses
5-
`pylibmc <http://github.com/lericson/pylibmc>`_ and setup connection to each
6-
node in cluster using
7-
`auto discovery <http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/AutoDiscovery.html>`_
8-
function.
5+
`pylibmc <http://github.com/lericson/pylibmc>`_ and sets up a connection to each
6+
node in the cluster using
7+
`auto discovery <http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/AutoDiscovery.html>`_.
98

109

1110
Requirements
@@ -56,11 +55,13 @@ Another solutions
5655

5756
ElastiCache provides memcached interface so there are three solution of using it:
5857

59-
1. Memcached configured with location = Configuration Endpoint. In this case your application
60-
will randomly connect to nodes in cluster and cache will be used with not optimal
61-
way. At some moment you will be connected to first node and set item. Minute later
62-
you will be connected to another node and will not able to get this item.
58+
1. Memcached configured with location = Configuration Endpoint
59+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6360

61+
In this case your application
62+
will randomly connect to nodes in cluster and cache will be used with not optimal
63+
way. At some moment you will be connected to first node and set item. Minute later
64+
you will be connected to another node and will not able to get this item.
6465

6566
::
6667

@@ -74,10 +75,13 @@ ElastiCache provides memcached interface so there are three solution of using it
7475
::
7576

7677

77-
2. Memcached configured with all nodes. It will work fine, memcache client will
78-
separate items between all nodes and will balance loading on client side. You will
79-
have problems only after adding new nodes or delete old nodes. In this case you should
80-
add new nodes manually and don't forget update your app after all changes on AWS.
78+
2. Memcached configured with all nodes
79+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
80+
81+
It will work fine, memcache client will
82+
separate items between all nodes and will balance loading on client side. You will
83+
have problems only after adding new nodes or delete old nodes. In this case you should
84+
add new nodes manually and don't forget update your app after all changes on AWS.
8185

8286
::
8387

@@ -94,9 +98,11 @@ ElastiCache provides memcached interface so there are three solution of using it
9498
::
9599

96100

97-
3. Use django-elasticache. It will connect to cluster and retrieve ip addresses
98-
of all nodes and configure memcached to use all nodes.
101+
3. Use django-elasticache
102+
~~~~~~~~~~~~~~~~~~~~~~~~~
99103

104+
It will connect to cluster and retrieve ip addresses
105+
of all nodes and configure memcached to use all nodes.
100106

101107
::
102108

0 commit comments

Comments
 (0)