You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -56,16 +58,26 @@ Run it offline and online with a single config, enjoy advanced file-matching pat
56
58
57
59
</div>
58
60
61
+
<hr/>
59
62
60
63
# INSTALLATION
61
64
62
65
```bash
63
66
npm install @donedeal0/codefather --save-dev
64
67
```
65
68
69
+
<hr/>
70
+
66
71
# USAGE
67
72
68
-
**Codefather** has 3 commands:
73
+
## TLDR
74
+
75
+
```bash
76
+
npx codefather-init
77
+
npm run codefather
78
+
```
79
+
80
+
## Commands
69
81
70
82
-`codefather`: checks if your access rules are respected in your repository.
71
83
-`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`:
84
96
}
85
97
```
86
98
87
-
Or directly run the commands with `npx`:
99
+
Or directly run the commands with `npx`.
88
100
89
-
```bash
90
-
npx codefather-init
91
-
npx codefather
92
-
```
101
+
<hr/>
93
102
94
103
# CONFIG
95
104
@@ -270,10 +279,14 @@ We believe open source libraries should be both useful and entertaining. The Don
270
279
271
280
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.
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
0 commit comments