Skip to content

Commit

Permalink
docs: prettify readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vcwild committed Aug 15, 2022
1 parent 080890b commit f5218c5
Show file tree
Hide file tree
Showing 2 changed files with 95 additions and 5 deletions.
71 changes: 71 additions & 0 deletions .github/assets/hook.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 24 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
<div align="center">
<img src=".github/assets/hook.svg" width="200px" />
<div>
<img src="https://img.shields.io/github/v/release/vcwild/norminette-hook?include_prereleases&color=%23FBC86D&style=flat-square" alt="release">
<img src="https://img.shields.io/github/license/vcwild/norminette-hook?color=%23FBC86D&style=flat-square" alt="license" />
<img src="https://img.shields.io/github/repo-size/vcwild/norminette-hook?color=%23FBC86D&style=flat-square" alt="repo size" />
</div>
</div>

# Norminette Hook

The Norminette pre-commit hook.

## Requirements
## πŸ“ Requirements

- [Pre-commit](https://pre-commit.com/index.html) must be installed on the system or in the repository virtual environment.
- [Pre-commit](https://pre-commit.com/index.html) must be installed system-wide or in a virtual environment.

## Usage
## πŸ’Ώ Usage

Create a `.pre-commit-config.yaml` file in the root of your repository.

Expand All @@ -23,10 +32,20 @@ repos:
- id: norminette-hook
```
When executing `pre-commit run` or `pre-commit run norminette-hook`, the hook will be executed.
When executing `pre-commit run` or `pre-commit run norminette-hook`, the hook will be triggered.

Now install the hook to be executed automatically for each commit.
Now install the hook to execute it automatically for each commit.

```bash
pre-commit install --install-hooks --overwrite
```

You are now ready for some next level linting automation! πŸ‘¨β€πŸš€πŸš€

## 🀝 Contributing

Fork the repository and create a pull request.

## 🏷️ License

The project is under the [MIT License](https://opensource.org/licenses/MIT). The software is provided as is, without warranty of any kind.

0 comments on commit f5218c5

Please sign in to comment.