Skip to content

Commit

Permalink
chore: add readme to packages
Browse files Browse the repository at this point in the history
  • Loading branch information
paradoxuum committed Jul 17, 2024
1 parent 284510d commit dacc7af
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
26 changes: 26 additions & 0 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<div align="center">
<a href="https://centurion.paradoxum.dev/" target="_blank">
<img src="../../docs/src/assets/logo.webp" width="150" />
</a>

<h1>Centurion</h1>

<p>
<strong>A flexible and extensible command framework for roblox-ts</strong>
</p>

[![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

<a href="https://centurion.paradoxum.dev/">📖 Documentation</a>
</div>

<img src="../../public/banner.png" />
29 changes: 29 additions & 0 deletions packages/ui/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<div align="center">
<a href="https://centurion.paradoxum.dev/" target="_blank">
<img src="../../docs/src/assets/logo.webp" width="150" />
</a>

<h1>Centurion - UI</h1>

<p>
<strong>A flexible and extensible command framework for roblox-ts</strong>
</p>

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

<a href="https://centurion.paradoxum.dev/">📖 Documentation</a>
</div>

<img src="../../public/banner.png" />

0 comments on commit dacc7af

Please sign in to comment.