README

changeset 8
281b2c05bff0
child 11
85c18da60925
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Sat Jul 31 21:43:28 2010 +0100
@@ -0,0 +1,33 @@
+---------- - ------------------------------
+Mooncached - the moon on a stick (of RAM) -
+---------- -  -----------------------------
+
+Mooncached is a tiny memcached server written in Lua. You can use it
+to store and retrieve chunks of data from your applications.
+
+Installation
+------------
+Mooncached is mostly standalone - it just depends on LuaSocket, which
+is available in most BSD and Linux distributions, and from its site
+at http://luasocket.luaforge.net/ .
+
+Configuration
+-------------
+Just run mooncached.lua. It listens on port 11211 (the default
+memcached port). You can use Squish
+(http://matthewwild.co.uk/projects/squish ) to produce a standalone
+"mooncached" script.
+
+Usage
+-----
+Any Memcached client library should work with Mooncached, see
+http://code.google.com/p/memcached/wiki/Clients for a list.
+
+Contact
+-------
+Matthew Wild <mwild1@gmail.com>
+
+Licence
+-------
+Mooncached is licensed under the MIT/X11 licence, the same as Lua
+5.1 itself.

mercurial