52 lines
2.1 KiB
Markdown
52 lines
2.1 KiB
Markdown
# Carbon
|
|
|
|
<div align="center">
|
|
<a href="https://go.buape.com/carbon"><img src="https://cdn.buape.com/carbon/wordmark.png" alt="Carbon Wordmark"></a>
|
|
|
|
<img alt="Discord" src="https://img.shields.io/discord/1280628625904894072?style=for-the-badge">
|
|
<img alt="NPM Version" src="https://img.shields.io/npm/v/@buape/carbon?style=for-the-badge">
|
|
<img alt="NPM Downloads" src="https://img.shields.io/npm/dm/@buape/carbon?style=for-the-badge">
|
|
</div>
|
|
|
|
Carbon is a fully-featured framework for building HTTP Discord bots, built in TypeScript and designed to be easy to use and understand.
|
|
|
|
## Features
|
|
|
|
- Fully up to date with the Discord API
|
|
- Build to be both flexible and powerful
|
|
- Easy to use class-based system for reusability
|
|
- Built in pagination support (Soon!)
|
|
- Integration with Discord's Monetization (Soon!)
|
|
|
|
## Why Carbon?
|
|
|
|
Carbon is designed to be easy to use and understand, while still providing the flexibility and power needed to build complex bots.
|
|
With Carbon, you can deploy it to many platforms, both physical and serverless, and it's easy to integrate with other frameworks and libraries.
|
|
|
|
## Installation
|
|
|
|
To get started with Carbon, you can check out the [Getting Started](https://carbon.buape.com/carbon/getting-started) guides for your preferred platform.
|
|
|
|
## Useful Links
|
|
|
|
- [Documentation](https://carbon.buape.com/carbon)
|
|
- [Discord](https://go.buape.com/carbon)
|
|
- [NPM](https://www.npmjs.com/package/@buape/carbon)
|
|
- [Cloudflare Workers Demo](https://github.com/buape/carbon/tree/main/apps/cloudo)
|
|
- [Node.js Demo](https://github.com/buape/carbon/tree/main/apps/rocko)
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions to Carbon! If you're interested in contributing, please check out the [Contributing Guide](https://carbon.buape.com/carbon/helpful-guides/contributing) for more information, and join our [Discord](https://go.buape.com/carbon) to get involved!
|
|
|
|
### All Contributors
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
<!-- prettier-ignore-start -->
|
|
<!-- markdownlint-disable -->
|
|
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
|
|
<!-- markdownlint-restore -->
|
|
<!-- prettier-ignore-end --> |