diff --git a/README.md b/README.md index 88d3891..282164c 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,8 @@ Run it offline and online with a single config, enjoy advanced file-matching pat |Commit blockage | ✅ | ❌ | |Godfather vibe (optional) | ✅ | ❌ | +
+ # SCREENSHOTS
@@ -56,6 +58,7 @@ Run it offline and online with a single config, enjoy advanced file-matching pat
+
# INSTALLATION @@ -63,9 +66,18 @@ Run it offline and online with a single config, enjoy advanced file-matching pat npm install @donedeal0/codefather --save-dev ``` +
+ # 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`. @@ -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 -``` +
# CONFIG @@ -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. +
+ # CREDITS DoneDeal0 | talk.donedeal0@gmail.com +
+ # 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. @@ -286,6 +299,8 @@ Premium support is also available. https://github.com/sponsors/DoneDeal0
+
+ # CONTRIBUTING Issues and pull requests are welcome!