Update README.md

Author: OSpoon

README.md

@@ -1,2 +1,22 @@
-# codegenius-verify-plugin
-校验 COMMIT_EDITMSG 中的信息是否符合 Angualr 规范
+# @codegenius/verify-plugin
+
+校验 `COMMIT_EDITMSG` 中的信息是否符合 **Angualr** 规范, 支持命令模式和 **API** 模式;
+
+使用场景: 用于校验正在执行 `git commit` 时所提交的信息是否符合规范.
+
+### 命令模式
+
+```bash
+codeg verify
+```
+
+### API 模式
+
+```typescript
+import { gitCommitVerify } from "code-genius";
+
+(async () => {
+  await gitCommitVerify();
+  console.log("Git 提交信息校验通过, 正在执行后续逻辑...");
+})();
+```