Update README.md

This commit is contained in:
SeungJu Lim 2024-03-23 12:17:21 +00:00
parent e0a97bc06d
commit 0c3168627f
1 changed files with 37 additions and 1 deletions

View File

@ -1,2 +1,38 @@
# discord_allnight
# Caffeine Bot
Caffeine Bot enhances Discord server interactions and management, offering essential features in a user-friendly package.
## Features
- **Ping Command**: Checks bot latency with a simple `ping` -> `Pong!` response.
- **Censoring Specific Words**: Maintains a respectful environment by censoring predefined words.
- **URL Embeds**: Generates rich previews for shared links, currently supporting `dcinside.com`.
## Setup
1. **Prerequisites**: Install Node.js.
2. **Installation**: Clone the repository and run `npm install`.
3. **Configuration**: Create a `.env` file at the root with your `TOKEN` and `CLI_ID`.
4. **Launch**: Execute `node app.js` to start the bot.
Additionally, we are using **Docker** to host our bots.
## Adding to Your Server
Create and invite the bot through the Discord Developer Portal, using the OAuth2 URL with appropriate permissions.
## Usage
Caffeine Bot automatically processes commands and messages upon joining a server. No additional configuration needed.
## Contribute
Suggestions and contributions are welcome via pull requests or issues.
## Contact
For inquiries or support, reach out to seungju.dev@gmail.com.
## License
Distributed under the MIT License.