-
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: initial all-contributors setup
- Loading branch information
1 parent
dfd96cd
commit 971d73d
Showing
2 changed files
with
55 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "projectName": "carbon", | ||
| "projectOwner": "buape" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Carbon | ||
|
|
||
| <div align="center"> | ||
| <a href="https://go.buape.com/carbon"><img src="https://cdn.buape.com/CarbonWordmark.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! | ||
|
|
||
| ## Contributors | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-disable --> | ||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:END --> |