|
1 | 1 | <div align="center"> |
2 | | - <img src="https://raw.githubusercontent.com/underctrl-io/commandkit/master/apps/docs/public/ckit_logo.svg" width="60%" /> |
3 | | - <br /> |
4 | | - <a href="https://ctrl.lol/discord"><img src="https://img.shields.io/discord/1055188344188973066?color=5865F2&logo=discord&logoColor=white" alt="support server" /></a> |
5 | | - <a href="https://www.npmjs.com/package/commandkit"><img src="https://img.shields.io/npm/v/commandkit?maxAge=3600" alt="npm version" /></a> |
6 | | - <a href="https://www.npmjs.com/package/commandkit"><img src="https://img.shields.io/npm/dt/commandkit?maxAge=3600" alt="npm downloads" /></a> |
| 2 | + <img src="https://raw.githubusercontent.com/underctrl-io/commandkit/master/apps/docs/public/ckit_logo.svg" width="60%" /> |
| 3 | + <br /> |
| 4 | + <a href="https://ctrl.lol/discord"><img src="https://img.shields.io/discord/1055188344188973066?color=5865F2&logo=discord&logoColor=white" alt="support server" /></a> |
| 5 | + <a href="https://www.npmjs.com/package/commandkit"><img src="https://img.shields.io/npm/v/commandkit?maxAge=3600" alt="npm version" /></a> |
| 6 | + <a href="https://www.npmjs.com/package/commandkit"><img src="https://img.shields.io/npm/dt/commandkit?maxAge=3600" alt="npm downloads" /></a> |
7 | 7 | </div> |
8 | 8 |
|
9 | | -You are currently looking at the next major version of CommandKit. You can view the `master` branch [here](https://github.com/underctrl-io/commandkit/tree/master) |
| 9 | +*You are currently looking at the next major version of CommandKit. You can view the `master` branch [here](https://github.com/underctrl-io/commandkit/tree/master)* |
10 | 10 |
|
11 | | -## Support and Suggestions |
| 11 | +--- |
12 | 12 |
|
13 | | -If you are looking for support or want to provide suggestions, check out the [Discord](https://ctrl.lol/discord). |
| 13 | +CommandKit is a powerful and easy-to-use command and event handler for your Discord.js project. It takes away the hassle of manually registering commands & event listeners, and lets you focus on the core features of your bot. It also offers additional features that make bot development a lot easier such as commands validation, developer-only commands, and permissions validation. |
| 14 | + |
| 15 | +The quickest way to setup a CommandKit project is to use the `create-commandkit` CLI: |
| 16 | + |
| 17 | +```sh |
| 18 | +npm create commandkit@next |
| 19 | +``` |
14 | 20 |
|
15 | 21 | ## Links |
16 | 22 |
|
17 | | -- [Website](https://commandkit.js.org) ([source](https://github.com/underctrl-io/commandkit/tree/master/apps/docs)) |
| 23 | +- [Documentation](https://commandkit.js.org) ([source](https://github.com/underctrl-io/commandkit/tree/next/apps/docs)) |
18 | 24 | - [Support Server](https://ctrl.lol/discord) |
19 | | -- [CommandKit source](https://github.com/underctrl-io/commandkit/tree/master/packages/commandkit) |
| 25 | +- [CommandKit source](https://github.com/underctrl-io/commandkit/tree/next/packages/commandkit) |
20 | 26 | - [npm](https://www.npmjs.com/package/commandkit) |
21 | | - |
22 | | -## Contributing |
23 | | - |
24 | | -Check out the [contributors guide](https://github.com/underctrl-io/commandkit/blob/master/CONTRIBUTING.md) |
| 27 | +- [Contributors guide](https://github.com/underctrl-io/commandkit/blob/next/CONTRIBUTING.md) |
0 commit comments