File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -42,6 +42,8 @@ Run it offline and online with a single config, enjoy advanced file-matching pat
4242| Commit blockage | ✅ | ❌ |
4343| Godfather vibe (optional) | ✅ | ❌ |
4444
45+ <hr />
46+
4547# SCREENSHOTS
4648
4749<div style =" display : flex ; flex-wrap : wrap ; gap : 8px ;" >
@@ -56,16 +58,26 @@ Run it offline and online with a single config, enjoy advanced file-matching pat
5658
5759</div >
5860
61+ <hr />
5962
6063# INSTALLATION
6164
6265``` bash
6366npm install @donedeal0/codefather --save-dev
6467```
6568
69+ <hr />
70+
6671# USAGE
6772
68- ** Codefather** has 3 commands:
73+ ## TLDR
74+
75+ ``` bash
76+ npx codefather-init
77+ npm run codefather
78+ ```
79+
80+ ## Commands
6981
7082- ` codefather ` : checks if your access rules are respected in your repository.
7183- ` codefather-init ` : creates a default config at the root of your repository and adds a ` codefather ` command to your ` package.json ` .
@@ -84,12 +96,7 @@ You can either add a script shortcut in your `package.json`:
8496}
8597```
8698
87- Or directly run the commands with ` npx ` :
88-
89- ``` bash
90- npx codefather-init
91- npx codefather
92- ```
99+ Or directly run the commands with ` npx ` .
93100
94101# CONFIG
95102
You can’t perform that action at this time.
0 commit comments