add a README

diff --git a/README b/README
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..50112b95c191a39017bf9920dc3ae8f92b51b4dc 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,31 @@
+LuaIRC v0.3
+Jesse Luehrs (jluehrs2@uiuc.edu)
+
+OVERVIEW
+========
+LuaIRC is a fully featured IRC framework written entirely in Lua. It provides an event driven system for connecting to IRC servers and responding to actions such as messages, joins/parts, and channel mode changes, among other things. DCC SEND is also fully implemented, both for sending and receiving files.
+
+INSTALL
+=======
+This module requires LuaSocket (http://www.cs.princeton.edu/~diego/professional/luasocket/) and Lua 5.1. To install, modify the Make.config file with paths appropriate to your system and run 'make install'.
+
+DOCUMENTATION
+=============
+Documentation of the API can be found in the doc/ directory. It was autogenerated from the source files by LuaDoc (http://luadoc.luaforge.net/).
+
+LuaIRC has only been tested on Freenode so far, but I plan to expand this to other servers in the future. It's quite possible that it works on other servers anyway, however, so feel free to try it out, and send in bug reports for things that break.
+
+CHANGES
+=======
+0.3
+- Major cleanup and restructuring again, documentation added, first public release
+0.2
+- Major cleanup and restructuring
+0.1
+- Initial implementation, enough to get it talking to the IRC server
+
+COPYRIGHT AND LICENSE
+=====================
+Copyright (C) 2007 Jesse Luehrs
+
+This code is distributed under the MIT license; a copy is in the LICENSE file distributed with the source.