diff --git a/packages/discordeno/README.md b/packages/discordeno/README.md new file mode 100644 index 000000000..84e1f5d28 --- /dev/null +++ b/packages/discordeno/README.md @@ -0,0 +1,30 @@ +# Discordeno + + + +Discord API library for [Node.JS](https://nodejs.org), [Deno](https://deno.land) & [Bun](https://bun.sh/) + +[![Discord](https://img.shields.io/discord/785384884197392384?color=7289da&logo=discord&logoColor=dark)](https://discord.com/invite/5vBgXk3UcZ) +[![codecov](https://codecov.io/gh/discordeno/discordeno/branch/main/graph/badge.svg?token=SQI9OYJ7AK)](https://codecov.io/gh/discordeno/discordeno) +![action status](https://github.com/discordeno/discordeno/actions/workflows/lib-check.yml/badge.svg?event=push) + +Discordeno is actively maintained to guarantee **excellent performance, latest features, and ease of use.** + +- **Simple, Efficient, and Lightweight**: Discordeno is lightweight, simple to use, and adaptable. + - By default: No caching. +- **Functional API**: + - The functional API eliminates the challenges of extending built-in classes and inheritance while ensuring overall simple but performant code. +- **Cross Runtime**: Supports the Node.js, Deno, and Bun runtimes. +- **Standalone components**: Discordeno offers the option to have practically any component of a bot as a separate + piece, including standalone REST, gateways, custom caches, and more. +- **Flexibility/Scalability:** Remove any properties, if your bot doesn't need them. For instance, remove `Channel.topic` if your bot doesn't require it. You may save GBs of RAM in this way. A few lines of code are all that are needed to accomplish this for any property on any object. + +### Custom Cache + +Have your cache setup in any way you like. Redis, PGSQL or any cache layer you would like. + +## Links + +- [Website](https://discordeno.js.org/) +- [Documentation](https://discordeno.js.org) +- [Discord](https://discord.com/invite/5vBgXk3UcZ)