updating documentation

wasimusu · Jul 30, 2020 · eef5d2b · eef5d2b
1 parent 7972f64
commit eef5d2b
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -9,16 +9,18 @@ similar caching/database systems like Redis, Memcached.
 
 Features
 ========
-1. All basic python data types and objects made from their combination are supported. For instance, int, str, dict, set, tuple, list, etc and their objects that have only these types as their attributes are supported.
+1. Data types supported:
+    - All basic data types and their combination. For instance, int, str, dict, set, tuple, list, etc and
+    objects that have only these types as their attributes are supported.
+    - You can even read any object (image, pdfs, etc) in binary format and save them as key, value pair.
 2. Key cache operations are logged so when the server fails, the cache can be reconstructed from the log files.
 3. The APIs are similar to Memcached and Redis to reduce cognitive when migrating between platforms.
 4. Since, distcache has pure python implementation the installation process should painless. It's makes it easier to get started up and running.
 5. Its' architecture assumes that the cache clients and servers can fail and plans for it. The impact is minimal on adding and removing cache servers.
-
-Coming Up
-=========
-1. Health monitoring of clients and servers.
-2. Support for binary data, images, pdf documents.
+6. Snapshot the servers at regular intervals to avoid cold starts upon crash or planned shutdowns
+7. Log replays also available for slow but complete reconstruction of the cache upon server crash, error or shutdown.
+8. Thread safe increment and decrement operations on keys.
+9. Health of the cache servers is monitored by the client.
 
 Install
 =======

diff --git a/readme.md b/readme.md
@@ -15,7 +15,7 @@ See [wiki](https://github.com/wasimusu/distcache/wiki) or [readthedocs](https://
 ### Features
 1. Data types supported:
     - All basic data types and their combination. For instance, int, str, dict, set, tuple, list, etc and
-    their objects that have only these types as their attributes are supported.
+    objects that have only these types as their attributes are supported.
     - You can even read any object (image, pdfs, etc) in binary format and save them as key, value pair.
 2. Key cache operations are logged so when the server fails, the cache can be reconstructed from the log files.
 3. The APIs are similar to Memcached and Redis to reduce cognitive when migrating between platforms.
@@ -24,9 +24,7 @@ See [wiki](https://github.com/wasimusu/distcache/wiki) or [readthedocs](https://
 6. Snapshot the servers at regular intervals to avoid cold starts upon crash or planned shutdowns
 7. Log replays also available for slow but complete reconstruction of the cache upon server crash, error or shutdown.
 8. Thread safe increment and decrement operations on keys.
-
-### Coming Up
-1. Health monitoring of clients and servers.
+9. Health of the cache servers is monitored by the client.
 
 ### Install
 ```

diff --git a/setup.py b/setup.py
@@ -3,7 +3,7 @@
 
 setup(
     name='distcache',
-    version='0.1.3',
+    version='0.1.3.1',
     author='Wasim Akram Khan',
     keywords='open-source, cache, distributed-cache, in-memory, database',
     description='Distcache is a python open-source distributed in-memory cache and database.',