Readme and license
This commit is contained in:
parent
4087f2ceb3
commit
d3d5c8b21b
21
LICENSE
Normal file
21
LICENSE
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2023 Roberto Alsina <roberto.alsina@gmail.com>
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
20
README.md
Normal file
20
README.md
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
# Pre-commit hooks.
|
||||||
|
|
||||||
|
Hooks to use with [Pre-commit](https://pre-commit.com/)
|
||||||
|
|
||||||
|
To use them, add this in your `.pre-commit-config.yml`
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- repo: https://git.ralsina.me/ralsina/pre-commit-hooks.git
|
||||||
|
rev: main
|
||||||
|
hooks:
|
||||||
|
- id: whatever-hook-you-like
|
||||||
|
```
|
||||||
|
|
||||||
|
After you install, you can use `pre-commit autoupdate` when it complains that main is whatever.
|
||||||
|
|
||||||
|
Current hooks:
|
||||||
|
|
||||||
|
## ameba
|
||||||
|
|
||||||
|
Run the [Ameba](https://github.com/crystal-ameba/ameba) static analysis tool for [Crystal](https://crystal-lang.org)
|
Loading…
Reference in New Issue
Block a user