Skip to content

Commit

Permalink
chore: update README for install
Browse files Browse the repository at this point in the history
  • Loading branch information
ShenQingchuan committed Oct 14, 2023
1 parent a88e902 commit d6df566
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 30 deletions.
20 changes: 20 additions & 0 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,26 @@

![示例预览](./packages/docs/src/public/highlight-demo.png)

## 安装

```bash
# 如果你还没有安装 `@antfu/ni`,我强烈建议你安装它。
ni -D vue-vine
```

`vite.config.ts` 中使用插件:

```ts
import { VineVitePlugin } from 'vue-vine/vite'

export default defineConfig({
plugins: [
// ...其他插件
VineVitePlugin()
],
})
```

## 即刻尝鲜

**注意:** 目前,Vue Vine 仍处于密集开发阶段,请不要将其用于生产环境。
Expand Down
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,26 @@ Take a quick view:

![Quick view](./packages/docs/src/public/highlight-demo.png)

## Install

```bash
# If you didn't install `@antfu/ni` yet, I highly recommend you to install it.
ni -D vue-vine
```

Use the plugin in `vite.config.ts`:

```ts
import { VineVitePlugin } from 'vue-vine/vite'

export default defineConfig({
plugins: [
// ...Other plugins
VineVitePlugin()
],
})
```

## Try the demo

**warning:** For now, `Vue Vine` is still under heavily development, please don't use it in production.
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
"esno": "^0.16.3",
"lint-staged": "^13.3.0",
"pkgroll": "^1.11.0",
"playwright-chromium": "^1.37.1",
"rimraf": "^5.0.1",
"rollup": "^3.28.1",
"shelljs": "^0.8.5",
Expand Down
1 change: 0 additions & 1 deletion packages/e2e-test/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
"@vue/test-utils": "^2.4.1",
"@vue/tsconfig": "^0.4.0",
"jsdom": "^22.1.0",
"playwright-chromium": "^1.37.1",
"typescript": "^5.2.2",
"vite": "^4.4.9",
"vitest": "^0.31.4",
Expand Down
34 changes: 5 additions & 29 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d6df566

Please sign in to comment.