aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjluehrs2 <jluehrs2@uiuc.edu>2007-09-04 22:54:10 -0500
committerjluehrs2 <jluehrs2@uiuc.edu>2007-09-04 22:54:10 -0500
commitb00550f74988063b756b75c0318bd67119e1b007 (patch)
tree599320fbf38cbd9864f1eb699850451b7ef26c58
parentceae608c52ed28cfe21b5e14e22c0045be450317 (diff)
downloadluairc-b00550f74988063b756b75c0318bd67119e1b007.tar.gz
luairc-b00550f74988063b756b75c0318bd67119e1b007.zip
add a README
-rw-r--r--README31
1 files changed, 31 insertions, 0 deletions
diff --git a/README b/README
index e69de29..50112b9 100644
--- 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.