Skip to content

Commit 010f42f

Browse files
committed
fix: doc typo
1 parent 7082ede commit 010f42f

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff 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
6366
npm 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,9 @@ You can either add a script shortcut in your `package.json`:
8496
}
8597
```
8698

87-
Or directly run the commands with `npx`:
99+
Or directly run the commands with `npx`.
88100

89-
```bash
90-
npx codefather-init
91-
npx codefather
92-
```
101+
<hr/>
93102

94103
# CONFIG
95104

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

271280
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.
272281

282+
<hr/>
283+
273284
# CREDITS
274285

275286
DoneDeal0 | [email protected]
276287

288+
<hr/>
289+
277290
# SUPPORT
278291

279292
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.
@@ -286,6 +299,8 @@ Premium support is also available. https://github.com/sponsors/DoneDeal0
286299
</a>
287300
<br/>
288301

302+
<hr/>
303+
289304
# CONTRIBUTING
290305

291306
Issues and pull requests are welcome!

0 commit comments

Comments
 (0)