Skip to content

Commit a6843c8

Browse files
committed
docs(README): add installation and usage instructions for SoybeanUI
1 parent 3bd6fa7 commit a6843c8

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,35 @@
22

33
SoybeanUI is built on top of SoybeanHeadless, providing a collection of styled components for Vue 3.
44

5+
## Installation
6+
7+
```bash
8+
pnpm add @soybeanjs/ui
9+
```
10+
11+
## Usage
12+
13+
- import styles
14+
15+
```ts
16+
import '@soybeanjs/ui/styles.css';
17+
```
18+
19+
- use with `unplugin-vue-components`
20+
21+
```ts
22+
import Components from 'unplugin-vue-components/vite';
23+
import UiResolver from '@soybeanjs/ui/resolver';
24+
25+
export default defineConfig({
26+
plugins: [
27+
Components({
28+
resolvers: [UiResolver()]
29+
})
30+
]
31+
});
32+
```
33+
534
## Roadmap
635

736
### Components

0 commit comments

Comments
 (0)