Update docs directives.

[awesomized/libmemcached] / README

diff --git a/README b/README
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..a664bc0db2c196f2461e949fcb28d249d0b9369b 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,43 @@
+Hi!
+
+So what is this? It is a library in C for connecting 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 server.
+memstat - Dump the stats of your servers to standard output
+memslap - Load generation utility (benchmark!)
+
+The library is in production in many locations (upwards to 1000+ nodes).
+
+The project has information here: http://libmemcached.org/
+
+Documentation can be found here: http://docs.libmemcached.org/
+
+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, but one is listed on the homepage that is supported
+by someone in the community.
+
+If you are looking for answers to your questions please check out the
+mailing list at:
+http://lists.libmemcached.org/  
+
+Subscription information for the libmemcached mailing list can be found there.
+
+Please report bugs here:
+https://bugs.launchpad.net/libmemcached/
+
+You can purchase support from:
+http://datadifferential.com/
+
+
+Cheers,
+  -Brian Aker
+   Seattle, WA.