Skip to content

Commit 1e07a1a

Browse files
committed
refactor: rename generator CLI to milkygen
1 parent 26d2e55 commit 1e07a1a

3 files changed

Lines changed: 10 additions & 4 deletions

File tree

docs/content/awesome.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Milky 作为一个新生的应用接口标准,得到了来自社区的广泛
3939

4040
Milky 的协议内容以 Milky IR 的形式发布在 npm 包 [@saltify/milky-protocol](https://www.npmjs.com/package/@saltify/milky-protocol) 中,提供了 Milky IR 的原始文件和 TypeScript 导出。Milky IR 本身为 JSON 格式的协议定义,包含了 Milky 协议的所有细节内容,具体格式与介绍见上述包的 README 文件。
4141

42-
[@saltify/milky-generator](https://www.npmjs.com/package/@saltify/milky-generator) (MIT) 是基于 Milky IR 的代码生成 CLI,支持生成多种目标格式的类型定义,并且可以指定版本号,方便开发者根据需要生成不同版本的 Milky 协议定义。
42+
[milkygen](https://www.npmjs.com/package/milkygen) (MIT) 是基于 Milky IR 的代码生成 CLI,支持生成多种目标格式的类型定义,并且可以指定版本号,方便开发者根据需要生成不同版本的 Milky 协议定义。
4343

4444
### Type Definitions
4545

generator/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# @saltify/milky-generator
1+
# milkygen
22

33
Milky 代码生成 CLI,用于基于 Milky IR 生成不同目标格式的规范文件。
44

55
## 安装
66

77
```bash
8-
npm install -g @saltify/milky-generator
8+
npm install -g milkygen
99
```
1010

1111
安装后可直接使用命令:
@@ -14,6 +14,12 @@ npm install -g @saltify/milky-generator
1414
milkygen
1515
```
1616

17+
或直接使用 npx:
18+
19+
```bash
20+
npx milkygen
21+
```
22+
1723
## 命令
1824

1925
### 生成内容

generator/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@saltify/milky-generator",
2+
"name": "milkygen",
33
"type": "module",
44
"version": "0.3.1",
55
"description": "Milky codegen CLI",

0 commit comments

Comments
 (0)