Skip to content

Commit f2cb119

Browse files
authored
Update README.md
1 parent 2404956 commit f2cb119

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,38 @@
1-
# codegenius-template-plugin
2-
运行 cg 生成 CodeGenius 内置模板项目
1+
# @codegenius/template-plugin
2+
3+
基于 **CodeGenius** 内置模板快速创建新项目, 仅支持询问模式;
4+
5+
使用场景: 用于创建青睐 **CodeGenius** 模板的新的项目 (目前模板为 `vitejs` 内置, 主要在模拟功能, 模板后续更新后可用).
6+
7+
### 询问模式
8+
9+
```bash
10+
# 启动询问模式(默认)
11+
codeg template
12+
```
13+
14+
```
15+
# 询问过程
16+
1. 请输入项目名称
17+
2. 请输入 package name
18+
3. 请选择下列的有效模板
19+
4. 请选择下列的有效变体
20+
```
21+
22+
```bash
23+
# 启动询问模式(带参)
24+
codeg template -n project-salkdyfT -f vue
25+
```
26+
27+
| 选项 | 描述 |
28+
| ----------------------------------- | -------- |
29+
| -n, --project-name \<project-name\> | 项目名称 |
30+
| -f, --framework \<framework\> | 项目框架 |
31+
32+
```
33+
# 询问过程
34+
1. 请输入项目名称 (-n 输入则仅需确认)
35+
2. 请输入 package name
36+
3. 请选择下列的有效模板 (-f 输入有效则跳过)
37+
4. 请选择下列的有效变体
38+
```

0 commit comments

Comments
 (0)