Create README.md

This commit is contained in:
2024-09-28 22:10:53 -04:00
committed by pacnpal
parent b9a81d1c2a
commit 90c3d997f5

34
README.md Normal file
View File

@@ -0,0 +1,34 @@
# Pac-cogs - RedBot Cogs Collection
Welcome to **Pac-cogs**, a collection of custom cogs for [RedBot](https://github.com/Cog-Creators/Red-DiscordBot). These cogs are designed to add extra functionality to your RedBot instance on Discord.
## Cogs Overview
| Cog Name | Description |
|------------|--------------------------------------------------|
| **Birthday** | Assigns a special birthday role to users and sends a celebratory message with random cake or pie emojis. Automatically removes the birthday role at midnight, with a configurable timezone. Offers the option to set a specific announcement channel and restricts usage to specified roles. Users can assign the role without needing a higher role in the hierarchy. |
## Installation
To install the cogs in this repository, follow these steps:
1. Ensure you have [RedBot](https://github.com/Cog-Creators/Red-DiscordBot) set up.
2. Add this repository to your RedBot instance:
```bash
[p]repo add Pac-cogs https://github.com/pacnpal/Pac-cogs
```
3. Install the **birthday** cog:
```bash
[p]cog install Pac-cogs birthday
```
4. Load the installed cog:
```bash
[p]load birthday
```
For more details on setting up and managing RedBot, visit the [RedBot documentation](https://docs.discord.red).