From 2c81eef6e6ef4fcf1b148dc351ddcfe1223d251c Mon Sep 17 00:00:00 2001
From: Gordon Shumway <39967334+oddluck@users.noreply.github.com>
Date: Thu, 19 Dec 2019 03:09:17 -0500
Subject: [PATCH] Create README.md

---
 RedditBot/README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 RedditBot/README.md

diff --git a/RedditBot/README.md b/RedditBot/README.md
new file mode 100644
index 0000000..26b544c
--- /dev/null
+++ b/RedditBot/README.md
@@ -0,0 +1,11 @@
+This plugin downloads comment data from subreddits to generate chat replies via markov chains.
+
+```redditbot csv [subreddit1] [subreddit2] [etc.]``` - download data from subreddits as csv files
+
+```redditbot model [channel] [subreddit1] [subreddit2] [etc.]``` - generate channel markov model from subreddit csv files
+
+```config channel [channel] plugins.redditbot.enable``` - Enable RedditBot for the channel
+
+```config channel [channel] plugins.redditbot.probability``` - Probability of reply on channel message 0.0 - 1.0
+
+```config channel [channel] plugins.redditbot.probabilityWhenAddressed``` - Probability of reply on channel message containing bot's nick. 0.0 - 1.0