Skip to content

Commit

Permalink
workflow: add cli args and update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Chieffo2021 committed Oct 22, 2021
1 parent 33a1aa3 commit 338d9a8
Show file tree
Hide file tree
Showing 5 changed files with 720 additions and 1,995 deletions.
11 changes: 6 additions & 5 deletions README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ webpack-to-vite 已被官方收录,[详情](https://github.com/vitejs/awesome-

## 快速开始

1. 下载
直接通过 npx 使用:
```
npm install @originjs/webpack-to-vite -g
$ npx @originjs/webpack-to-vite <project path>
```
2. 转换
...或者全局安装使用:
```
webpack-to-vite -d <project path>
$ npm install @originjs/webpack-to-vite -g
$ webpack-to-vite <project path>
```
> 注意:默认转换的是 vue-cli 项目。 传入 `-t webpack` 选项来转换 webpack 项目。
Expand All @@ -23,7 +24,7 @@ webpack-to-vite -d <project path>
```
$ webpack-to-vite --help
Usage: webpack-to-vite [options]
Usage: webpack-to-vite [options] [root]
Options:
-v, --version 显示版本号
Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ It has been offically included, [detail](https://github.com/vitejs/awesome-vite#

## Quick Start

1. download
Use it directly with npx:
```
npm install @originjs/webpack-to-vite -g
$ npx @originjs/webpack-to-vite <project path>
```
2. convert
...or install it globally:
```
webpack-to-vite -d <project path>
$ npm install @originjs/webpack-to-vite -g
$ webpack-to-vite <project path>
```
> Note: the default conversion is vue-cli project. Pass in the `-t webpack` option to convert a webpack project.
Expand All @@ -23,7 +24,7 @@ The CLI provides the following options:
```
$ webpack-to-vite --help
Usage: webpack-to-vite [options]
Usage: webpack-to-vite [options] [root]
Options:
-v, --version display version number
Expand Down
Loading

0 comments on commit 338d9a8

Please sign in to comment.