From 574b5be085ec88c069570bdd8e036e2b9eca7277 Mon Sep 17 00:00:00 2001
From: Noikoio <noikoio1@gmail.com>
Date: Mon, 17 Sep 2018 14:03:00 -0700
Subject: [PATCH] Updated Readme; Add DBots Description HTML

---
 Discord Bots descrption.html | 28 ++++++++++++++++++++++++++++
 Readme.md                    | 20 ++++++++++++++++----
 2 files changed, 44 insertions(+), 4 deletions(-)
 create mode 100644 Discord Bots descrption.html

diff --git a/Discord Bots descrption.html b/Discord Bots descrption.html
new file mode 100644
index 0000000..5141c12
--- /dev/null
+++ b/Discord Bots descrption.html	
@@ -0,0 +1,28 @@
+<div style="width: 80%; margin-left: auto; margin-right: auto;">
+<p>Help command: <i>bb.help</i>.</p>
+<hr style="width: 20%" />
+<p><b>Recognize birthdays in your Discord community!</b></p>
+<br />
+<p>This bot will automatically add a role to users during their birthdays. If desired, it will also announce birthdays in a channel of your choosing. Time zones are supported per-server and per-user to ensure that birthdays and events are recognized at appropriate times.</p>
+<br />
+<p>
+<b>Setup</b>
+<ol style="margin-left: 3em;">
+    <li>Create a dedicated birthday role for use by the bot.</li>
+    <li>Invite the bot to your server. Ensure that the bot is able to manipulate this role.</li>
+    <li>Instruct the bot to use the role: `bb.config role (role name)`</li>
+    <li>(Optional) Set a birthday announcement channel: `bb.config channel (channel)`</li>
+    <li>(Optional) Set a server default time zone: `bb.config zone (time zone)`</li>
+</ol>
+</p>
+<br />
+<p>
+<b>Other details</b>
+<ul style="margin-left: 3em;list-style-type: circle;">
+    <li>Birthday information is not shared between servers. If you are in multiple servers that this bot is in, you must register your birthday (including time zone) within each server.</li>
+    <ul style="margin-left: 2em;list-style-type: circle;">
+        <li>This is in case one wishes to share their birthday only in certain communities.</li>
+    </ul>
+    <li>Problematic users? This bot supports blocking certain or all users from using commands. Server moderators are able to issue commands on a user's behalf.</li>
+</ul>
+</div>
\ No newline at end of file
diff --git a/Readme.md b/Readme.md
index 49245bf..6454ee2 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,7 +1,19 @@
-# BirthdayBot
+# Birthday Bot
 
-Discord birthday reminder bot.
+Recognize birthdays in your Discord community!
 
-Currently a major work in progress. Code may be restructured and features added, modified, or deleted.
+Invite: https://discordapp.com/oauth2/authorize?client_id=470673087671566366&scope=bot
 
-It is usable, however. A public instance exists. Contact me if you want it in your server.
\ No newline at end of file
+This bot will automatically add a role to users during their birthdays. If desired, it will also announce birthdays in a channel of your choosing. Time zones are supported per-server and per-user to ensure that birthdays and events are recognized at appropriate times.
+
+## Setup
+1. Create a dedicated birthday role for use by the bot.
+2. Invite the bot to your server. Ensure that the bot is able to manipulate this role.
+3. Instruct the bot to use the role: `bb.config role (role name)`
+4. (Optional) Set a birthday announcement channel: `bb.config channel (channel)`
+5. (Optional) Set a server default time zone: `bb.config zone (time zone)`
+
+## Other details
+* Birthday information is not shared between servers. If you are in multiple servers that this bot is in, you must register your birthday (including time zone) within each server.
+  * This is in case one wishes to share their birthday only in certain communities.
+* Problematic users? This bot supports blocking certain or all users from using commands. Server moderators are able to issue commands on a user's behalf.
\ No newline at end of file