diff --git a/LICENSE b/LICENSE.md similarity index 100% rename from LICENSE rename to LICENSE.md diff --git a/README.md b/README.md index 0ceff45f..9e6a9c89 100644 --- a/README.md +++ b/README.md @@ -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 - 📖 Documentation + [📖 Documentation](https://centurion.paradoxum.dev/) + + ![banner](public/banner.png) +**Centurion** is a flexible command framework built for roblox-ts. + +## ✨ Features - +- ✏️ **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)) +
+This project is released under the MIT License. +
-- [Flamework](https://github.com/rbxts-flamework/core): Metadata reflection API ([see usage](packages/core/src/shared/core/metadata.ts)) +