Skip to content

Commit 1a15d86

Browse files
authored
docs: update README.md
1 parent 54375f7 commit 1a15d86

File tree

1 file changed

+5
-10
lines changed

1 file changed

+5
-10
lines changed

README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,8 @@ Use [shadcn/ui](https://ui.shadcn.com) or [shadcn-vue](https://shadcn-vue.com) o
1313

1414
## Usage
1515

16-
Follow official guide to setup shadcn/ui, shadcn-vue or shadcn-svelte.
16+
Follow the official guide to set up [shadcn/ui](https://ui.shadcn.com/docs/installation/vite), [shadcn-vue](https://www.shadcn-vue.com/docs/installation/vite.html), or [shadcn-svelte](https://www.shadcn-svelte.com/docs/installation). Replace the step to set up Tailwind CSS with [UnoCSS](https://unocss.dev/integrations/vite).
1717

18-
1. [shadcn/ui](https://ui.shadcn.com/docs/installation/vite)
19-
1. [shadcn-vue](https://www.shadcn-vue.com/docs/installation/vite.html)
20-
1. [shadcn-svelte](https://www.shadcn-svelte.com/docs/installation)
21-
22-
Replace the step to setup Tailwind CSS with [UnoCSS](https://unocss.dev/integrations/vite).
2318
Then install `unocss-preset-shadcn` and `unocss-preset-animations`, and update your `unocss.config.ts`:
2419

2520
```bash
@@ -41,8 +36,8 @@ export default defineConfig({
4136
}),
4237
],
4338
// By default, `.ts` and `.js` files are NOT extracted.
44-
// If you want to extract them, you can use the following configuration.
45-
// It's necessary to add following configuration if you are using shadcn-vue or shadcn-svelte.
39+
// If you want to extract them, use the following configuration.
40+
// It's necessary to add the following configuration if you use shadcn-vue or shadcn-svelte.
4641
content: {
4742
pipeline: {
4843
include: [
@@ -146,7 +141,7 @@ Svelte + shadcn-svelte
146141

147142
Preview the [demo](https://unocss-preset-shadcn.vercel.app).
148143

149-
If you want to use dynamic theme, you can pass a array of theme objects to `presetShadcn`:
144+
If you want to use a dynamic theme, you can pass an array of theme objects to `presetShadcn`:
150145

151146
```ts
152147
import { defineConfig, presetUno, UserConfig } from "unocss"
@@ -163,7 +158,7 @@ export default defineConfig({
163158
```
164159

165160
Add a theme sync script to your [index.html](./playground/index.html).
166-
And to dynamically change the theme, you can create a [theme switch component](./playground/src/components/theme-switch.tsx).
161+
To dynamically change the theme, you can create a [theme switch component](./playground/src/components/theme-switch.tsx).
167162

168163
## See also
169164

0 commit comments

Comments
 (0)