discord-embed-builder-kit
v1.0.1
Published
A powerful utility for creating rich and visually appealing embeds in Discord using discord.js.
Downloads
1
Maintainers
Readme
# Discord Embed Builder
[![npm version](https://badge.fury.io/js/discord-embed-builder.svg)](https://badge.fury.io/js/discord-embed-builder)
A powerful utility for creating rich and visually appealing embeds in Discord using discord.js.
## Installation
```shell
npm install discord-embed-builder
Features
- Simple and intuitive API for constructing embeds in Discord.
- Customize embeds with titles, descriptions, fields, and colors.
- Supports inline fields and color customization.
- Enhance visual communication with eye-catching embeds.
Usage
const { sendEmbed } = require('discord-embed-builder');
// Example usage
const channel = client.channels.cache.get('YOUR_CHANNEL_ID');
const embedTitle = 'Example Embed';
const embedDescription = 'This is an example embed.';
const embedFields = [
{ name: 'Field 1', value: 'Value 1' },
{ name: 'Field 2', value: 'Value 2', inline: true },
{ name: 'Field 3', value: 'Value 3', inline: true },
];
const embedColor = '#00FF00'; // Optional, defaults to white
sendEmbed(channel, embedTitle, embedDescription, embedFields, embedColor);
For more detailed usage examples, please refer to the Documentation.
Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue for any improvements or new features you'd like to add.
License
This project is licensed under the MIT License.
Remember to replace `'YOUR_CHANNEL_ID'`, `'your-username'`, and any other placeholder values with the appropriate information. You can also include additional sections, such as installation instructions, usage examples, and contribution guidelines, based on your package's specific requirements.
Feel free to customize the README.md file further to provide more details about your package and its usage.