Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Zhengqbbb committed Sep 26, 2024
1 parent 4620874 commit 115846b
Show file tree
Hide file tree
Showing 12 changed files with 21 additions and 21 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,14 @@ DX first and more engineered, lightweight, customizable, standard output format

```bash
$ npm i -D cz-git
+ cz-git (1.9 MB)
added 1 package in 0.582s
+ cz-git (1.75 MB)
added 1 package in 0.552s
```

[⇒ Why czg](https://cz-git.qbb.sh/cli/why.html)
```bash
$ npm i -g czg
+ czg (1.5 MB)
+ czg (1.31 MB)
added 1 package in 0.531s
```

Expand Down Expand Up @@ -179,7 +179,7 @@ added 1 package in 0.531s
[⇒ FAQ](https://cz-git.qbb.sh/faq/)

<a target="_blank" href="https://packagephobia.com/result?p=cz-git,czg">
<img src="https://user-images.githubusercontent.com/40693636/252157675-32634902-fc02-4a07-a12c-a07ec5ee5f1a.png" alt="size-overview"><br>
<img src="https://cdn.jsdelivr.net/gh/Zhengqbbb/[email protected]/image/cz-git-v1.10.0.png" alt="size-overview"><br>
<sub>https://packagephobia.com/result?p=cz-git,czg</sub>
</a>

Expand Down
4 changes: 2 additions & 2 deletions docs/.vitepress/theme/components/HomePage.vue
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ useMediumZoom()
$ npm install -D cz-git<br>
+ cz-git
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
(<span c-orange-5> 1.9 MB </span>) <br>added &nbsp;<span c-orange-5>1</span>&nbsp; package
in &nbsp;<span c-orange-5>0.582s</span>
(<span c-orange-5> 1.75 MB </span>) <br>added &nbsp;<span c-orange-5>1</span>&nbsp; package
in &nbsp;<span c-orange-5>0.552s</span>
</p>
</div>
<div class="feat">
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ description: Interactive Commitizen CLI that generate standardized git commit me
<br />

- 🤖 **OpenAI Support.** Let the AI generate your git commit message.
- ⚡️ **Lightweight** : Zero Dependencies (1.6MB)
- ⚡️ **Lightweight** : Zero Dependencies (1.31MB)
- 🤗 **Simpler and Faster** : No plugin, No adapter, No extra steps, You can use `npx` | `npm script` | `global install`... quick start CLI in your any project
- 😎 **Highly Customizable** : Internally contains the core of cz-git. Extend all the features of cz-git. Same behavior, Same configuration loader... You can customize the commit CLI according to your need

Expand Down
4 changes: 2 additions & 2 deletions docs/cli/why.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ $ du -sh ./node_modules
102M ./node_modules
$ npm install -D czg
added 1 package, and audited 2 packages in 408 ms
added 1 package, and audited 2 packages in 531 ms
$ du -sh ./node_modules/*
1.3M ./node_modules/czg
1.31M ./node_modules/czg
```

## What is different from cz-git
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ Support OpenAI, and more engineered, lightweight, customizable, standard output

```sh
$ npm install -D cz-git
+ cz-git (1.9 MB)
added 1 package in 0.582s
+ cz-git (1.75 MB)
added 1 package in 0.552s
```

[⇒ Why cz-git](/guide/why.html)
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/why.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ $ npm install -D cz-conventional-changelog
added 147 packages in 21s
$ npm install -D cz-git
added 1 package in 0.582s
added 1 package in 0.552s
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ description: 交互式命令行工具 (Commitizen CLI) 生成标准化的 git co
<br />

- 🤖 **OpenAI 支持.** 让 AI 来辅助生成你 git commit 的描述信息
- ⚡️ **轻量级** : 零依赖项 (1.6MB)
- ⚡️ **轻量级** : 零依赖项 (1.31MB)
- 🤗 **简单且快速** : 无需前置配置,无需适配器,没有额外的步骤,你可以使用 `npx` | `npm 脚本` | `全局下载`... 在你的任何项目中快速启动
- 😎 **高度可定制化** : 内部包含 cz-git 的核心,继承了 cz-git 的所有特性,具有相同的行为,配置加载... 你可以根据自己的需要配置的 CLI 的行为

Expand Down
4 changes: 2 additions & 2 deletions docs/zh/cli/why.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ $ du -sh ./node_modules
102M ./node_modules
$ npm install -D czg
added 1 package, and audited 2 packages in 408 ms
added 1 package, and audited 2 packages in 531 ms
$ du -sh ./node_modules/*
1.3M ./node_modules/czg
1.31M ./node_modules/czg
```

## 与 cz-git 相比有什么不同
Expand Down
4 changes: 2 additions & 2 deletions docs/zh/guide/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ sitemap:

```sh
$ npm install -D cz-git
+ cz-git (1.9 MB)
added 1 package in 0.582s
+ cz-git (1.75 MB)
added 1 package in 0.552s
```

[⇒ 为什么是 cz-git](/zh/guide/why.html)
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/guide/why.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ $ npm install -D cz-conventional-changelog
added 147 packages in 21s
$ npm install -D cz-git
added 1 package in 0.582s
added 1 package in 0.552s
```

---
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Interactive Commitizen CLI that generate standardized git commit message
<br/>

- 🤖 **OpenAI Support.** Let the AI generate your git commit message description.
- ⚡️ **Lightweight** : Zero Dependencies (1.6MB)
- ⚡️ **Lightweight** : Zero Dependencies (1.31MB)
- 🤗 **Simpler and Faster** : No plugin, No adapter, No extra steps, You can use `npx` | `npm script` | `global install`... quick start CLI in your any project
- 😎 **Highly Customizable** : Internally contains the core of cz-git. Extend all the features of cz-git. Same behavior, Same configuration loader... You can customize the commit CLI according to your need

Expand Down
4 changes: 2 additions & 2 deletions packages/cz-git/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ A support OpenAI, and more engineered, lightweight, customizable, standard outpu

```bash
$ npm i -D cz-git
+ cz-git (1.9 MB)
added 1 package in 0.582s
+ cz-git (1.75 MB)
added 1 package in 0.552s
```

## Usage
Expand Down

0 comments on commit 115846b

Please sign in to comment.