From 4d1546953e2b6556143d1e1ab066c8b4c9f0a481 Mon Sep 17 00:00:00 2001 From: Avraj Sahota Date: Tue, 6 Feb 2024 12:08:12 +0300 Subject: [PATCH] fix: branch urls + add description --- README.md | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index b421726..a192b98 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,27 @@
- -
- support server - npm version - npm downloads + +
+ support server + npm version + npm downloads
-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) +*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)* -## Support and Suggestions +--- -If you are looking for support or want to provide suggestions, check out the [Discord](https://ctrl.lol/discord). +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. + +The quickest way to setup a CommandKit project is to use the `create-commandkit` CLI: + +```sh +npm create commandkit@next +``` ## Links -- [Website](https://commandkit.js.org) ([source](https://github.com/underctrl-io/commandkit/tree/master/apps/docs)) +- [Documentation](https://commandkit.js.org) ([source](https://github.com/underctrl-io/commandkit/tree/next/apps/docs)) - [Support Server](https://ctrl.lol/discord) -- [CommandKit source](https://github.com/underctrl-io/commandkit/tree/master/packages/commandkit) +- [CommandKit source](https://github.com/underctrl-io/commandkit/tree/next/packages/commandkit) - [npm](https://www.npmjs.com/package/commandkit) - -## Contributing - -Check out the [contributors guide](https://github.com/underctrl-io/commandkit/blob/master/CONTRIBUTING.md) +- [Contributors guide](https://github.com/underctrl-io/commandkit/blob/next/CONTRIBUTING.md)