From dacc7af72ac963c05927601830ee7e85b9724473 Mon Sep 17 00:00:00 2001 From: paradoxuum Date: Wed, 17 Jul 2024 18:44:27 +0100 Subject: [PATCH] chore: add readme to packages --- packages/core/README.md | 26 ++++++++++++++++++++++++++ packages/ui/README.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 packages/core/README.md create mode 100644 packages/ui/README.md diff --git a/packages/core/README.md b/packages/core/README.md new file mode 100644 index 00000000..9459f4dd --- /dev/null +++ b/packages/core/README.md @@ -0,0 +1,26 @@ +
+ + + + +

Centurion

+ +

+ A flexible and extensible command framework for roblox-ts +

+ + [![CI status][ci-badge]][ci-url] + [![npm latest version][npm-latest-badge]][npm-latest-url] + [![npm dev version][npm-next-badge]][npm-next-url] + + [npm-latest-badge]: https://img.shields.io/npm/v/%40rbxts%2Fcenturion?logo=npm&label=latest&color=green + [npm-latest-url]: https://www.npmjs.com/package/@rbxts/centurion/v/latest + [npm-next-badge]: https://img.shields.io/npm/v/%40rbxts%2Fcenturion%2Fnext?logo=npm&label=next + [npm-next-url]: https://www.npmjs.com/package/@rbxts/centurion/v/next + [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 +
+ + \ No newline at end of file diff --git a/packages/ui/README.md b/packages/ui/README.md new file mode 100644 index 00000000..758842de --- /dev/null +++ b/packages/ui/README.md @@ -0,0 +1,29 @@ +
+ + + + +

Centurion - UI

+ +

+ A flexible and extensible command framework for roblox-ts +

+ + This package contains Centurion's user interface. To use it, you must + also install [@rbxts/centurion](https://www.npmjs.com/package/@rbxts/centurion). + + [![CI status][ci-badge]][ci-url] + [![npm latest version][npm-latest-badge]][npm-latest-url] + [![npm dev version][npm-next-badge]][npm-next-url] + + [npm-latest-badge]: https://img.shields.io/npm/v/%40rbxts%2Fcenturion?logo=npm&label=latest&color=green + [npm-latest-url]: https://www.npmjs.com/package/@rbxts/centurion/v/latest + [npm-next-badge]: https://img.shields.io/npm/v/%40rbxts%2Fcenturion%2Fnext?logo=npm&label=next + [npm-next-url]: https://www.npmjs.com/package/@rbxts/centurion/v/next + [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 +
+ + \ No newline at end of file