Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zekroTJA committed Nov 20, 2021
1 parent ce12c3d commit 57d6f96
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ For basic usage examples, see the [basic example section](examples/basic). Examp

This package was primarily written with the motivation to use it in my Discord bot [shinpuru](https://github.com/zekroTJA/shinpuru).

## All you need to know

- [Docs](https://pkg.go.dev/github.com/zekrotja/ken)
- [Examples](examples/)
- [Releases](https://github.com/zekroTJA/ken/releases)
- ["Real World" Examples](#projects-using-ken)

## Why should you use this package?

It may sound crazy, but `ken` tries to simplify the complexity behind application command registration and command handling while giving you full control over the event handling and registration process.
Expand Down Expand Up @@ -137,6 +144,13 @@ If you are not familiar with regex, the name must match the following conditions

*¹ The pattern described in the Discord docs `^[\w-]{1,32}$` is actually not accurate, because you can not use uppercase letters in names, but you can use underscores.*

## Projects using ken

> If you used ken in your project, feel free to add it here with a [pull request](https://github.com/zekroTJA/ken/pulls). 😉
- [zekrotja/shinpuru](https://github.com/zekrotja/shinpuru)
- [zekrotja/dcdl](https://github.com/zekrotja/dcdl)

---

© 2021 Ringo Hoffmann (zekro Development).
Expand Down

0 comments on commit 57d6f96

Please sign in to comment.