Skip to content

Commit

Permalink
fix: branch urls + add description
Browse files Browse the repository at this point in the history
  • Loading branch information
notunderctrl committed Feb 6, 2024
1 parent 78327b9 commit 4d15469
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
<div align="center">
<img src="https://raw.githubusercontent.com/underctrl-io/commandkit/master/apps/docs/public/ckit_logo.svg" width="60%" />
<br />
<a href="https://ctrl.lol/discord"><img src="https://img.shields.io/discord/1055188344188973066?color=5865F2&logo=discord&logoColor=white" alt="support server" /></a>
<a href="https://www.npmjs.com/package/commandkit"><img src="https://img.shields.io/npm/v/commandkit?maxAge=3600" alt="npm version" /></a>
<a href="https://www.npmjs.com/package/commandkit"><img src="https://img.shields.io/npm/dt/commandkit?maxAge=3600" alt="npm downloads" /></a>
<img src="https://raw.githubusercontent.com/underctrl-io/commandkit/master/apps/docs/public/ckit_logo.svg" width="60%" />
<br />
<a href="https://ctrl.lol/discord"><img src="https://img.shields.io/discord/1055188344188973066?color=5865F2&logo=discord&logoColor=white" alt="support server" /></a>
<a href="https://www.npmjs.com/package/commandkit"><img src="https://img.shields.io/npm/v/commandkit?maxAge=3600" alt="npm version" /></a>
<a href="https://www.npmjs.com/package/commandkit"><img src="https://img.shields.io/npm/dt/commandkit?maxAge=3600" alt="npm downloads" /></a>
</div>

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)

0 comments on commit 4d15469

Please sign in to comment.