Skip to content

fix: doc typo #6

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: doc typo #6

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
27 changes: 21 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Run it offline and online with a single config, enjoy advanced file-matching pat
|Commit blockage | ✅ | ❌ |
|Godfather vibe (optional) | ✅ | ❌ |

<hr/>

# SCREENSHOTS

<div style="display: flex; flex-wrap: wrap; gap: 8px;">
Expand All @@ -56,16 +58,26 @@ Run it offline and online with a single config, enjoy advanced file-matching pat

</div>

<hr/>

# INSTALLATION

```bash
npm install @donedeal0/codefather --save-dev
```

<hr/>

# USAGE

**Codefather** has 3 commands:
## TLDR

```bash
npx codefather-init
npm run codefather
```

## Commands

- `codefather`: checks if your access rules are respected in your repository.
- `codefather-init`: creates a default config at the root of your repository and adds a `codefather` command to your `package.json`.
Expand All @@ -84,12 +96,9 @@ You can either add a script shortcut in your `package.json`:
}
```

Or directly run the commands with `npx`:
Or directly run the commands with `npx`.

```bash
npx codefather-init
npx codefather
```
<hr/>

# CONFIG

Expand Down Expand Up @@ -270,10 +279,14 @@ We believe open source libraries should be both useful and entertaining. The Don

This being said, if you don't like the gangster movie atmosphere and still want to use `codefather`, you can absolutely opt-out by providing your own custom messages and hiding the Don's face in the terminal.

<hr/>

# CREDITS

DoneDeal0 | talk.donedeal0@gmail.com

<hr/>

# SUPPORT

Show your support for **Codefather** by becoming a sponsor if you or your company uses it! Your name or company logo will be displayed in the `README` and on the website.
Expand All @@ -286,6 +299,8 @@ Premium support is also available. https://github.com/sponsors/DoneDeal0
</a>
<br/>

<hr/>

# CONTRIBUTING

Issues and pull requests are welcome!