Update domain name to kpe.io
[memstore.git] / memcache / README.md
index cd45d3c1d1f15fdfe3c6e8973b41e8b42a2c0641..c38888bd39b5354744ee3f6b43e01fbcf7ba1d49 100644 (file)
@@ -7,13 +7,15 @@ Author: Kevin Rosenberg <kevin@rosenberg.net>, based on the
 `cl-memcached` library by Abhijit 'quasi' Rao and 
 Chaitanya Gupta .
 
+Date Started: July 1, 2011
+
 Overview
 --------
 
-This package is based on the cl-memcached library.
-It is substantially modified for use with the memstore
-package. The primary areas of additional functionality
-are:
+This package is based on the `cl-memcached` library.  It is
+substantially modified for use with the
+[memstore](http://memstore.kpe.io) library. The primary areas of
+additional functionality are:
 
 * Support for flags field with get and set functions.
   This is required as memstore stores bit flags denoting
@@ -35,7 +37,7 @@ are:
   supported by `usocket` are now supported with `memcached`.
 
 * Encapsulated reading and writing to socket stream to avoid
-  handling \#return characters in high-level code.
+  handling \\#return characters in high-level code.
 
 * Changes to support the change in statistics fields with membase.
   Some fields were no longer present. Also, membase 1.7 has
@@ -46,9 +48,18 @@ are:
 * More robust `print-object` functions to avoid errors if fields
   in statistics are not present.
 
-* Removed compatibility functions in `compat.lisp` and using `kmrcl`
-  package to provide those functions as well as utilitizing other
-  `kmrcl` functions to simplify code.
+* Removed compatibility functions in `compat.lisp` by using the
+  [`kmrcl`](http://gitpub.kpe.io/kmrcl.git) library to provide those
+  functions as well as utilitizing other `kmrcl` functions to simplify
+  code.
+
+* Added functions to support all memcached API commands,
+  such as `flush_all` and `version`.
+
+* Support for the `moreply` command argument accepted by
+  many commands.
+
+* Support the `noreply` argument that many API commands accept.
 
-* Nearly the entire code base has been reworked for improved
-  robustness and efficiency.
+* Write nearly the entire code base for improved
+  clarity, robustness, and efficiency.