From 82b6607d65fc313f9abf3847b28002e2ad81262c Mon Sep 17 00:00:00 2001 From: Austin Peterson Date: Tue, 19 Jul 2016 11:53:35 -0500 Subject: [PATCH] some documentation. lots to go. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dc2c668..dae691d 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ -This documentation is placeholder documentation. Real docs coming soon. +irc-join-msg provides AKP48Squared with the ability to automatically send a message to anyone who joins an IRC channel, when they join. # Installation -This plugin is included by default on new installations of AKP48Squared. No further installation is needed. +Step 1: `git clone` this repo into your AKP48Squared plugins directory (See the AKP48Squared documentation for more details). +Step 2: Restart or reload the bot. # Usage +TODO: Finish documentation. Here's where we'll talk about how to use the plugin. More detail is available in the commands section below. # Commands