Huge refactoring of directory structure.

[awesomized/libmemcached] / README

diff --git a/README b/README
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..d91ccc961c739ae181dfac8bf903115d1a95cda4 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,26 @@
+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!)
+
+This code is still in Alpha. More tests have currently been done on the 
+library code then on the utilities.
+
+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.
+
+If you are looking for answers to your questions please check out the
+mailing list at:
+http://lists.tangent.org/  libmemcached.
+
+Cheers,
+  -Brian Aker
+   Seattle, WA.