diff --git a/LICENSE b/LICENSE index e62ec04..f9d9d74 100644 --- a/LICENSE +++ b/LICENSE @@ -657,7 +657,7 @@ notice like this when it starts in an interactive mode: This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. -The hypothetical commands `show w' and `show c' should show the appropriate +The hypothetical commands `show w' and`show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". diff --git a/birthday/README.md b/birthday/README.md index 36d9bff..03ee037 100644 --- a/birthday/README.md +++ b/birthday/README.md @@ -15,10 +15,13 @@ To install this cog, follow these steps: 1. Ensure you have Red-DiscordBot V3 installed. 2. Add the repository to your bot: + ``` [p]repo add Pac-cogs https://github.com/pacnpal/Pac-cogs ``` + 3. Install the cog: + ``` [p]cog install Pac-cogs birthday ``` @@ -26,6 +29,7 @@ To install this cog, follow these steps: ## Usage After installation, load the cog with: + ``` [p]load birthday ``` @@ -35,10 +39,13 @@ After installation, load the cog with: Before the cog can be used, an admin needs to set it up: 1. Set the birthday role: + ``` [p]birthdayset role @BirthdayRole ``` + 2. Add roles that can use the birthday command: + ``` [p]birthdayset addrole @AllowedRole ``` @@ -46,6 +53,7 @@ Before the cog can be used, an admin needs to set it up: ### Using the Birthday Command Users with allowed roles can assign the birthday role to a member: + ``` [p]birthday @User ``` diff --git a/birthday/__init__.py b/birthday/__init__.py new file mode 100644 index 0000000..79de37e --- /dev/null +++ b/birthday/__init__.py @@ -0,0 +1,7 @@ +from .birthday import Birthday + +__red_end_user_data_statement__ = "This allows users with the set roles to give the birthday role to users until the end of the day." + + +def setup(bot): + bot.add_cog(Birthday(bot)) \ No newline at end of file