From 9ac8d3fd290fa96ee4a900a05cd31acc43ccac85 Mon Sep 17 00:00:00 2001
From: reality <tinmachin3@gmail.com>
Date: Mon, 21 Jan 2013 20:38:16 +0000
Subject: [PATCH] readme for regex [#154]

---
 modules/regex/README.md   | 21 +++++++++++++++++++++
 modules/regex/config.json |  3 ++-
 2 files changed, 23 insertions(+), 1 deletion(-)
 create mode 100644 modules/regex/README.md

diff --git a/modules/regex/README.md b/modules/regex/README.md
new file mode 100644
index 0000000..2db1f02
--- /dev/null
+++ b/modules/regex/README.md
@@ -0,0 +1,21 @@
+## Regex
+
+Apply regex and that.
+
+### Description
+
+Allows you to run regex replaces on both your own and others messages. One may
+run a regex on their own last message like so:
+
+    > user: I like turtles
+    > user: s/turtles/pizza/
+
+One may run a regex on another user's last message simple by hilighting the nick
+before the pattern:
+
+    > batman: I like TURTLES
+    > user: batman: s/turtles/pizza/i
+
+Note: As this is JS regex, the second part of the regex is actually just a
+string and therefore some regex features aren't available (such as lookaheads).
+On a related note, the regex flags available for use are limited to i and g.
diff --git a/modules/regex/config.json b/modules/regex/config.json
index c945e96..a2a42c7 100644
--- a/modules/regex/config.json
+++ b/modules/regex/config.json
@@ -1,3 +1,4 @@
 {
-    "ignorable": true
+    "ignorable": true,
+    "help": "http://github.com/reality/depressionbot/blob/master/modules/regex/README.md"
 }