X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;ds=sidebyside;f=README;h=8ce3eef5e668715b108bc25a9f0cc55f094c6770;hb=72f2d0fe03fedf73e1ac542690736f881de830fe;hp=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391;hpb=aef60cba06c79c42f79532923aa49675386c552f;p=awesomized%2Flibmemcached

diff --git a/README b/README
index e69de29b..8ce3eef5 100644
--- a/README
+++ b/README
@@ -0,0 +1,34 @@
+Hi!
+
+So what is this? Its a library in C for connectinng to memcached servers
+(http://danga.com/memcached/). It is also a collection of utilities designed
+to work with memcached.
+
+memcat - Copy the value of a key to standard output
+memflush - Flush the contents of your servers.
+memrm - Remove a key(s) from the serrver.
+memstat - Dump the stats of your servers to standard output
+memslap - Load generation utility (benchmark!)
+
+The utilities are beta quality at this point. The library is in production
+in many locations (upwards to 600 nodes). For networks of more then 512
+hosts using consistent hashing, you must update the target WHEEL size for 
+number of hosts * 4 in libmemcached/memcached_constants.h. 
+
+Want to contribute? If you write more then three good patches, then I will
+just ask you to commit directly to the tree. I am happy to have additional
+people work on this project. Please checkout README.FIRST. 
+
+You will need a C99 compiler in order to compile this library. Currently we
+actively support Linux, MacOSX, FreeBSD, and Solaris. A Windows port is
+currently not supported.
+
+If you are looking for answers to your questions please check out the
+mailing list at:
+http://lists.tangent.org/  
+
+Subscribe to the libmemcached mailing list found there.
+
+Cheers,
+  -Brian Aker
+   Seattle, WA.