diff --git a/packages/ui/README.md b/packages/ui/README.md index e0629bab0..73f8efdb0 100644 --- a/packages/ui/README.md +++ b/packages/ui/README.md @@ -4,6 +4,25 @@ A stylized UI component library built with [Reka UI](https://reka-ui.com/). To preview the components, refer to the [`stage-ui`](../stage-ui) package for instructions for running the Histoire UI storyboard. +## Usage + +```shell +ni @proj-airi/ui -D # from @antfu/ni, can be installed via `npm i -g @antfu/ni` +pnpm i @proj-airi/ui -D +yarn i @proj-airi/ui -D +npm i @proj-airi/ui -D +``` + +```vue + + + +``` + ## Components * [Animations](src/components/Animations)