diff --git a/Discord Bots descrption.html b/Discord Bots descrption.html deleted file mode 100644 index f977c80..0000000 --- a/Discord Bots descrption.html +++ /dev/null @@ -1,31 +0,0 @@ -
-

Help command: bb.help.

-
-

Recognize birthdays in your Discord community!

-
-

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. -
  3. Invite the bot to your server. Ensure that the bot is able to manipulate this role.
  4. - -
  5. Instruct the bot to use the role: `bb.config role (role name)`
  6. -
  7. (Optional) Set a birthday announcement channel: `bb.config channel (channel)`
  8. -
  9. (Optional) Set a server default time zone: `bb.config zone (time zone)`
  10. -
-

-
-

- Other details -

-
\ No newline at end of file diff --git a/DiscordBots.md b/DiscordBots.md new file mode 100644 index 0000000..d6d87a8 --- /dev/null +++ b/DiscordBots.md @@ -0,0 +1,12 @@ +## Recognize birthdays in your Discord community! + +This bot will automatically set a role to users during their birthdays. If desired, birthdays will also be announced in a channel of your choosing. Time zones are supported per-user as well as per-server, and it is possible to limit usage of the bot if users are being abusive. + +#### Getting started +* Invite the bot. Be mindful that it requires role setting permissions. +* Create a dedicated birthday role to be used only by the bot. Ensure the new role is under the bot's role. + * **Do not use an existing role!** This bot assumes exclusive control over it. Any users without birthdays will have the role automatically removed. +* Instruct the bot to use the role: `bb.config role (role name)` +* Optional: Set a birthday announcement channel: `bb.config channel (channel) +* Optional: Set a server default time zone: `bb.config zone (time zone)` + * See the command `bb.help-tzdata` for more information on specifying a time zone.