add README

2013-10-29 23:41:53 -07:00 · 2013-10-29 23:41:53 -07:00 · 0b6627fae9
parent a5508e5ef2
commit 0b6627fae9
1 changed files with 13 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,13 @@
+Lambot is a simple IRC bot written in the [Lamb](https://github.com/darkf/lamb) programming language.
+
+Currently it supports:
+
+* Factoids (`$defact foo bar`, `$foo` says `bar`)
+* Ping (`$ping`)
+* Simple admin commands (`$savefacts`, `$join`, `$quit`)
+
+**Running**
+
+1. Install [Lamb](https://github.com/darkf/lamb)
+2. Configure the options in the beginning of `irc.lamb`
+3. Run `lamb irc.lamb`