czg 1.3.8 → 1.3.10-beta.1

package/README.md

@@ -3,22 +3,33 @@
 > Interactive Commitizen CLI that generate standardized commit messages
 
 <p align="center">
-    <a href="https://www.npmjs.com/package/czg">
-        <img style="display:inline-block;margin:0.2em;" alt="npm" src="https://img.shields.io/npm/v/czg?style=flat-square&logo=npm">
+    <a target="_blank" href="https://cz-git.qbb.sh/cli/">
+      <img style="display:inline-block;margin:0.2em;" alt="CLI-Link" src="https://img.shields.io/badge/Commitizen-CLI-red.svg?logo=git&style=flat">
     </a>
+    <a target="_blank" href="https://github.com/agarrharr/awesome-cli-apps#git">
+      <img style="display:inline-block;margin:0.2em;" alt="awesome-cli-app" src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg">
+    </a>
+    <br/>
     <a target="_blank" href="https://github.com/Zhengqbbb/cz-git">
       <img style="display:inline-block;margin:0.2em;" alt="GitHub Repo stars" src="https://img.shields.io/github/stars/zhengqbbb/cz-git?style=social">
     </a>
+    <br>
+    <a href="https://www.npmjs.com/package/czg">
+        <img style="display:inline-block;margin:0.2em;" alt="npm" src="https://img.shields.io/npm/v/czg?style=flat-square&logo=npm">
+    </a>
+    <a href="https://formulae.brew.sh/formula/czg">
+        <img style="display:inline-block;margin:0.2em;" alt="homebrew" src="https://img.shields.io/homebrew/v/czg?style=flat-square&logo=homebrew&label=homebrew">
+    </a>
 </p>
 
 <p align="center">
     <a href="https://github.com/Zhengqbbb/cz-git">Github</a>
     &nbsp; | &nbsp;
-    <a href="https://cz-git.qbenben.com/cli/install.html">Installation</a>
+    <a href="https://cz-git.qbb.sh/cli/install.html">Installation</a>
     &nbsp; | &nbsp;
-    <a href="https://cz-git.qbenben.com/cli/">Website</a>
+    <a href="https://cz-git.qbb.sh/cli/">Website</a>
     &nbsp; | &nbsp;
-    <a href="https://cz-git.qbenben.com/zh/cli/">简体中文文档</a>
+    <a href="https://cz-git.qbb.sh/zh/cli/">简体中文文档</a>
 </p>
 
 <br/>
@@ -45,7 +56,7 @@ Create a `.czrc` file in the project root directory
 ```
 
 > **Note**
-> More information about configure file and options. See → [Config](https://cz-git.qbenben.com/config/)
+> More information about configure file and options. See → [Config](https://cz-git.qbb.sh/config/)
 
 ## Features and Help
 
@@ -56,7 +67,7 @@ NAME:
     czg - Interactive Commitizen CLI that generate standardized commit messages
 
 WEBSITE:
-    https://cz-git.qbenben.com/cli/
+    https://cz-git.qbb.sh/cli/
     https://github.com/Zhengqbbb/cz-git
 
 SYNOPSIS:
@@ -69,13 +80,16 @@ SUBCOMMAND:
 
 OPTIONS:
     --config       Specify the configuration file to use
-    --retry|-r     Direct retry submit by the last message
-    --help|-h      Show help
-    --version      Show version
+    :, --alias     Directly submit the defined commit message
+    -r, --retry    Directly retry submit by the last message
+    -h, --help     Show help
+    -v, --version  Show version
 
 EXAMPLES:
     czg
     czg emoji
+    czg :ff
+    czg --alias=ff
     czg --config="./config/cz.json"
 
 Extends 'git commit' command and options.
@@ -84,29 +98,65 @@ See 'git commit --help' for more information.
 
 ## Installation
 
-```
+```sh
 npm install -g czg
 ```
 
-[⇒ Get Started](https://cz-git.qbenben.com/cli/install.html)
+> MacOS:
+
+```sh
+brew install czg
+```
+
 
-## Configure Template
+[⇒ Get Started (more installation and usage)](https://cz-git.qbb.sh/cli/install.html)
 
-[⇒ Configure Template](https://cz-git.qbenben.com/config/)
+## Configure
 
-## Options
+[⇒ Configure Template](https://cz-git.qbb.sh/config/)
 
-[⇒ Show Related](https://cz-git.qbenben.com/config/show.html)
+[⇒ Show Related](https://cz-git.qbb.sh/config/show.html)
 
-[⇒ Engineering Related](https://cz-git.qbenben.com/config/engineer.html)
+[⇒ Engineering Related](https://cz-git.qbb.sh/config/engineer.html)
 
 ## Recipes
 
-[⇒ Recipes](https://cz-git.qbenben.com/recipes/)
+[⇒ Recipes](https://cz-git.qbb.sh/recipes/)
 
 ## FAQ
 
-[⇒ FAQ](https://cz-git.qbenben.com/faq/)
+[⇒ FAQ](https://cz-git.qbb.sh/faq/)
+
+## Projects using czg CLI
+
+<table>
+  <tr>
+    <td align="center" width="200px">
+      <a target="_blank" href="https://github.com/element-plus/element-plus">
+        <img src="https://user-images.githubusercontent.com/40693636/172459748-939e3f1b-a694-4c09-b643-e1dce602105c.png" alt="Element Plus logo" width="40"><br>
+        <sub>Element Plus</sub>
+      </a>
+    </td>
+    <td align="center" width="200px">
+      <a target="_blank" href="https://github.com/Tencent/tdesign-vue-next">
+        <img src="https://user-images.githubusercontent.com/40693636/170830562-38e4c998-9af4-4303-9270-4f14e0942b08.png" alt="TDesign-Vue-Next logo" width="40"><br>
+        <sub>TDesign-Vue-Next</sub>
+      </a>
+    </td>
+    <td align="center" width="200px">
+      <a target="_blank" href="https://github.com/vbenjs/vue-vben-admin">
+        <img src="https://user-images.githubusercontent.com/40693636/178189964-931a1fc2-92df-4d04-8d0d-b748fc318c0a.png" alt="Vben-Admin logo" width="40"><br>
+        <sub>Vben-Admin</sub>
+      </a>
+    </td>
+    <td align="center" width="200px">
+      <a target="_blank" href="https://github.com/buqiyuan/vue3-antd-admin">
+        <img src="https://user-images.githubusercontent.com/40693636/170830597-31d6f0d7-2c93-491b-a984-7bf21db8f75b.png" alt="Vue3-Antd-Admin logo" width="40"><br>
+        <sub>Vue3-Antd-Admin</sub>
+      </a>
+    </td>
+  </tr>
+</table>
 
 ## LICENSE