Skip to content

Commit

Permalink
chore: improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
paradoxuum committed Oct 5, 2024
1 parent 5e4b7e9 commit 4cca1d7
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 11 deletions.
File renamed without changes.
31 changes: 20 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,33 @@
[ci-badge]: https://github.com/paradoxuum/centurion/actions/workflows/ci.yml/badge.svg?branch=main
[ci-url]: https://github.com/paradoxuum/centurion/actions/workflows/ci.yml

<a href="https://centurion.paradoxum.dev/">📖 Documentation</a>
[📖 Documentation](https://centurion.paradoxum.dev/)

![banner](public/banner.png)
</div>

**Centurion** is a flexible command framework built for roblox-ts.

## ✨ Features

<img src="public/banner.png" />
- ✏️ **Easy to use.** Centurion makes use of decorators to make defining commands easy and readable.
- 🚀 **Powerful.** Features like command guards and custom argument types allow for a wide range of flexibility.
- 🛠️ **Extensible.** Centurion's UI is optional and can easily be swapped out for a custom one.

## About
## 💖 Attributions

Centurion is a command framework built for roblox-ts.
- [🔥 Flamework](https://github.com/rbxts-flamework/core): Metadata reflection API ([see usage](packages/core/src/shared/core/metadata.ts))

- Commands are defined using decorators in an easy and readable manner.
- Custom argument types can be created, allowing for a great deal of flexibility for your commands.
- Comes with an optional user interface which can easily be swapped out for a custom one.
- [🐍 Slither](https://github.com/littensy/slither): Basic UI components and hooks

## Attributions
---

- [Cmdr](https://github.com/evaera/Cmdr): String utilities ([see usage](packages/core/src/shared/util/string.ts))
<p align="center">
This project is released under the <a href="LICENSE.md">MIT License</a>.
</p>

- [Flamework](https://github.com/rbxts-flamework/core): Metadata reflection API ([see usage](packages/core/src/shared/core/metadata.ts))
<div align="center">

- [Slither](https://github.com/littensy/slither): Basic UI components and hooks
[![MIT License](https://img.shields.io/github/license/littensy/charm-example?style=for-the-badge)](LICENSE.md)

</div>

0 comments on commit 4cca1d7

Please sign in to comment.