Skip to content

Commit 019bc95

Browse files
authored
Merge pull request #7 from DoneDeal0/add-doc-info
fix: add doc info
2 parents 160217f + 7dd37bb commit 019bc95

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,8 @@ You can either add a script shortcut in your `package.json`:
9898

9999
Or directly run the commands with `npx`.
100100

101+
> 👉 The CLI mode only checks files that are staged, unstaged, newly created, or deleted. Once a file is committed, it won’t be rechecked unless modified again. For full enforcement across all commits, use Codefather in a GitHub Action.
102+
101103
<hr/>
102104

103105
# CONFIG
@@ -139,7 +141,7 @@ export default {
139141

140142
## ⚙️ Here's how it works.
141143

142-
> The `CodefatherConfig` allows you to control which users can modify parts of your codebase, and to refine the behavior of `codefather`.
144+
The `CodefatherConfig` allows you to control which users can modify parts of your codebase, and to refine the behavior of `codefather`.
143145

144146
```ts
145147
type CodefatherConfig {
@@ -166,7 +168,7 @@ type CodefatherConfig {
166168
}
167169
```
168170

169-
> A `Rule` defines which users can change a set of files.
171+
A `Rule` defines which users can change a set of files.
170172

171173
```ts
172174
type CodefatherRule {

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@donedeal0/codefather",
3-
"version": "1.0.7",
3+
"version": "1.0.9",
44
"description": "Codefather protects your codebase by controlling who can change what. Set authorization levels, lock down files, and enforce your rules—offline via CLI or online with GitHub Actions.",
55
"license": "ISC",
66
"author": "DoneDeal0",

0 commit comments

Comments
 (0)