Skip to content

Commit 0968a49

Browse files
authored
Update README.md
1 parent 6fe016d commit 0968a49

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
1-
# @codegenius/hooks-plugin
1+
# @codegenius/hooks-plugin
2+
3+
新增或修改 `simple-git-hooks` 配置后需要重新初始化, 支持命令模式和 **API** 模式;
4+
5+
使用场景: 用于 `simple-git-hooks` 来配置 `git hooks` 的使用, 方便初始化和更新时使用, 混用过 `husky` 的会按其文档进行删除操作.
6+
7+
### 命令模式
8+
9+
```bash
10+
codeg hooks
11+
```
12+
13+
### API 模式
14+
15+
```typescript
16+
import { gitInitSimpleHooks } from "code-genius";
17+
18+
(async () => {
19+
await gitInitSimpleHooks();
20+
})();
21+
```

0 commit comments

Comments
 (0)