Skip to content

Commit 8ae1f3e

Browse files
authored
Update README.md
1 parent 17c2076 commit 8ae1f3e

File tree

1 file changed

+8
-16
lines changed

1 file changed

+8
-16
lines changed

README.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ A comprehensive Discord bot designed specifically for the Web Dev Discord server
5151
pnpm install
5252
```
5353

54-
3. Set up environment variables (create `.env` file):
54+
3. Set up environment variables (create `.env.local` file):
5555
```
5656
DISCORD_TOKEN=your_bot_token_here
57-
DISCORD_CLIENT_ID=your_client_id_here
58-
DISCORD_GUILD_ID=your_guild_id_here
57+
CLIENT_ID=your_client_id_here
58+
SERVER_ID=your_guild_id_here
5959
```
6060

6161
4. Build and start the bot:
@@ -72,8 +72,8 @@ A comprehensive Discord bot designed specifically for the Web Dev Discord server
7272
<br>
7373

7474

75-
### Docker Support
76-
To use docker with the bot:
75+
## Docker Support
76+
To use docker with the bot, run:
7777
```bash
7878
# Development
7979
pnpm run docker:dev
@@ -88,18 +88,10 @@ pnpm run docker:build
8888
<br>
8989

9090

91-
# Configuration
9291

93-
### Environment Variables
94-
- `DISCORD_TOKEN` - Discord bot token (required)
95-
- `DISCORD_CLIENT_ID` - Discord application client ID
96-
- `DISCORD_GUILD_ID` - Target guild/server ID
97-
- Additional moderation-specific configuration in `src/env.ts`
9892

99-
<br>
93+
# Required Permissions
10094

101-
### Bot Permissions
102-
The bot requires the following Discord permissions:
10395
- Send Messages
10496
- Read Message History
10597
- Manage Messages
@@ -120,14 +112,14 @@ The bot requires the following Discord permissions:
120112
<br>
121113

122114

123-
#### Adding New Guides/Tips
115+
### Adding New Guides or Tips
124116
1. Add markdown files to `src/commands/guides/subjects/` or `src/commands/tips/subjects/`
125117
2. Include frontmatter with `name` field
126118
3. The bot will automatically detect and load new content
127119

128120
<br>
129121

130-
## Support
122+
# Support
131123

132124
For issues, questions, or feature requests:
133125
- Open an issue on GitHub

0 commit comments

Comments
 (0)