Add readme

README.md

@@ -0,0 +1,40 @@
+# Yapper
+
+## World of Warcraft addon that *yaps* a given message in a given channel every now and then
+
+## Download [here!](https://git.site.quack-lab.dev/dave/wow-Yapper/media/branch/master/Yapper.zip)
+
+Interfacing with the addon is done entirely through two commands:
+
+## `/yap`
+- Main command that controls most of the parameters
+- Simply running `/yap` will cause the yapper to begin... yapping
+- `/yap <number>` sets the yap interval 
+  - `/yap 30` would send a message every 30 seconds
+- `/yap <string>` sets the yap message
+  - `/yap I'm a big strong boy!` would set the message to "I'm a big strong boy!"
+
+## `/yapc`
+- Controls the channel in which yapping takes place
+  - The available channels are:
+    - `CHANNEL` - Message to a server or custom chat channel (sent with /1, /2, etc in the default UI); requires channel number for channel argument
+	- `DND` - Enables Away-From-Keyboard status for the player, with text as the custom message seen by others attempting to whisper the player
+	- `EMOTE` - Custom text emotes visible to nearby players (sent with /e in the default UI)
+	- `GUILD` - Messages to guild members (sent with /g in the default UI)
+	- `INSTANCE_CHAT` - Messages to a LFG/LFR instance group (sent with /i in the default UI)
+	- `OFFICER` - Messages to guild officers (sent with /o in the default UI)
+	- `PARTY` - Messages to party members (sent with /p in the default UI)
+	- `RAID` - Messages to raid members (sent with /ra in the default UI)
+	- `RAID_WARNING` - Warning to raid members (sent with /rw in the default UI)
+	- `SAY` - Speech to nearby players (sent with /s in the default UI)
+	- `WHISPER` - Message to a specific character (sent with /w in the default UI); requires name of the character for channel argument
+	- `YELL` - Yell to not-so-nearby players (sent with /y in the default UI)
+- Some channels also require special data such as "CHANNEL" and "WHISPER"
+  - For `WHISPER` that is the target being whispered
+  - For `CHANNEL` that is the channel name
+- Example:
+  - `/yapc SAY` will make yapper use the say channel (/s)
+  - `/yapc YELL` will use yell channel (/y)
+  - `/yapc WHISPER` will error out - we are missing a recipient!
+  - `/yapc WHISPER Pinkleta` will whisper Pinkleta
+  - `/yapc CHANNEL world_ru` will yap to world channel