Skip to content

fix: add doc info #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DoneDeal0 merged 1 commit into from
Aug 16, 2025
Merged

fix: add doc info #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ You can either add a script shortcut in your `package.json`:

Or directly run the commands with `npx`.

> 👉 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.

<hr/>

# CONFIG
Expand Down Expand Up @@ -139,7 +141,7 @@ export default {

## ⚙️ Here's how it works.

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

```ts
type CodefatherConfig {
Expand All @@ -166,7 +168,7 @@ type CodefatherConfig {
}
```

> A `Rule` defines which users can change a set of files.
A `Rule` defines which users can change a set of files.

```ts
type CodefatherRule {
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@donedeal0/codefather",
"version": "1.0.7",
"version": "1.0.9",
"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.",
"license": "ISC",
"author": "DoneDeal0",
Expand Down