Skip to content

Commit f164137

Browse files
committed
feat: 0.0.9 修改readme
1 parent 415cb35 commit f164137

File tree

4 files changed

+84
-20
lines changed

4 files changed

+84
-20
lines changed

README.cn.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# ebuild-cli
2+
3+
### 🚀一键搭建webpack、babel、eslint、less、commitlint、typescript、vue、react等开发环境
4+
5+
<p>
6+
<a href="https://www.npmjs.com/package/ebuild-cli"><img src="https://img.shields.io/npm/v/ebuild-cli.svg" alt="Version"></a>
7+
<a href="https://npmcharts.com/compare/ebuild-cli?minimal=true"><img src="https://img.shields.io/npm/dm/ebuild-cli.svg" alt="Downloads"></a>
8+
<a href="https://github.com/theajack/ebuild-cli/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/ebuild-cli.svg" alt="License"></a>
9+
<a href="https://github.com/theajack/ebuild-cli/search?l=javascript"><img src="https://img.shields.io/github/languages/top/theajack/ebuild-cli.svg" alt="TopLang"></a>
10+
<a href="https://github.com/theajack/ebuild-cli/issues"><img src="https://img.shields.io/github/issues-closed/theajack/ebuild-cli.svg" alt="issue"></a>
11+
</p>
12+
13+
[English](https://github.com/theajack/ebuild-cli/blob/master/README.md)
14+
15+
## 1. 安装:
16+
17+
```
18+
npm i -g ebuild-cli
19+
```
20+
21+
## 2. 初始化
22+
23+
在你希望创建项目的目录下运行一下命令
24+
25+
```
26+
ebuild init <project name>
27+
28+
cd <project name>
29+
30+
npm install
31+
```
32+
33+
安装过程中有以下七个模板可供选择
34+
35+
1. 默认模式:包含webpack、babel、eslint、commitlint
36+
2. css模式:默认模式 + css和less支持
37+
3. typescript:默认模式 + ts 支持
38+
4. vue: vue2.x + vue-router + vuex
39+
5. vue3: vue3 + typescript + vue-router4 + vuex4
40+
6. react: react17 + typescript + redux + sass
41+
7. 原始模式:不推荐
42+
43+
----
44+
45+
附加功能: 启动一个开发服务器
46+
47+
```
48+
ebuild run
49+
```
50+
51+
## QA
52+
53+
如在windos上遇到 C:\xxx\Roaming\npm\ebuild.ps1,因为在此系统上禁止运行脚本。
54+
55+
请CMD执行 set-ExecutionPolicy RemoteSigned

README.md

Lines changed: 27 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,55 @@
11
# ebuild-cli
22

3-
### 🚀一键搭建webpack、babeleslintlesscommitlint、typescript等开发环境
3+
### 🚀 One-click build webpack, babel, eslint, less, commitlint, typescript, vue, react and other development environments
44

5-
## 1. 安装:
5+
<p>
6+
<a href="https://www.npmjs.com/package/ebuild-cli"><img src="https://img.shields.io/npm/v/ebuild-cli.svg" alt="Version"></a>
7+
<a href="https://npmcharts.com/compare/ebuild-cli?minimal=true"><img src="https://img.shields.io/npm/dm/ebuild-cli.svg" alt="Downloads"></a>
8+
<a href="https://github.com/theajack/ebuild-cli/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/ebuild-cli.svg" alt="License"></a>
9+
<a href="https://github.com/theajack/ebuild-cli/search?l=javascript"><img src="https://img.shields.io/github/languages/top/theajack/ebuild-cli.svg" alt="TopLang"></a>
10+
<a href="https://github.com/theajack/ebuild-cli/issues"><img src="https://img.shields.io/github/issues-closed/theajack/ebuild-cli.svg" alt="issue"></a>
11+
</p>
12+
13+
[中文](https://github.com/theajack/ebuild-cli/blob/master/README.cn.md)
14+
15+
## 1. Installation:
616

717
```
818
npm i -g ebuild-cli
919
```
1020

11-
## 2. 初始化
21+
## 2. Initialization
1222

13-
在你希望创建项目的目录下运行一下命令
23+
Run the following command in the directory where you want to create the project
1424

1525
```
16-
ebuild init <项目名称>
17-
```
26+
ebuild init <project name>
1827
19-
```
20-
cd <项目名称>
21-
```
28+
cd <project name>
2229
23-
```
2430
npm install
2531
```
2632

27-
安装过程中有以下四种模式可供选择
33+
There are seven templates to choose from during the installation process
2834

29-
1. 默认模式:包含webpack、babel、eslint、commitlint
30-
2. css模式:默认模式 + css和less支持
31-
3. typescript:默认模式 + ts 支持
32-
4. 原始模式:不推荐
35+
1. Default mode: including webpack, babel, eslint, commitlint
36+
2. css mode: default mode + css and less support
37+
3. typescript: default mode + ts support
38+
4. vue: vue2.x + vue-router + vuex
39+
5. vue3: vue3 + typescript + vue-router4 + vuex4
40+
6. react: react17 + typescript + redux + sass
41+
7. Original mode: not recommended
3342

3443
----
3544

36-
附加功能: 启动一个开发服务器
45+
Additional function: start a development server
3746

3847
```
3948
ebuild run
4049
```
4150

4251
## QA
4352

44-
如在windos上遇到 C:\xxx\Roaming\npm\ebuild.ps1,因为在此系统上禁止运行脚本。
53+
If you encounter C:\xxx\Roaming\npm\ebuild.ps1 on windos, it is forbidden to run scripts on this system.
4554

46-
请CMD执行 set-ExecutionPolicy RemoteSigned
55+
Please CMD execute set-ExecutionPolicy RemoteSigned

bin/ebuild-init.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ const gits = {
4343
url: 'github:theajack/react-ts',
4444
renderPackage: false,
4545
renderBuild: false,
46-
name: 'react (react17 + typescript + redux)',
46+
name: 'react (react17 + typescript + redux + sass)',
4747
},
4848
'origin': {
4949
url: 'github:theajack/ebuild-template',

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ebuild-cli",
3-
"version": "0.0.8",
3+
"version": "0.0.9",
44
"description": "A project for build a project easily",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)