diff --git a/README.md b/README.md index 2c4e0c478285642fead5b21eeda747f63f13969e..d73667148bbdbb07e1ef2331052baf6a413abce4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ # Git pre-commit hooks +[](https://travis-ci.org/adarnimrod/git-pre-commit) + [Pre-commit](http://pre-commit.com/) Git related hooks. + +- `merge-conflict`: Checks if your branch has merge conflicts with the master + branch. + +## Installation + +Add the following to your project's `.pre-commit-config.yaml`: + + - repo: https://www.shore.co.il/git/git-pre-commit + sha: v0.1.0 + hooks: + - id: merge-conflict + always_run: True + +## License + +This software is licensed under the MIT license (see the `LICENSE.txt` file). + +## Author information + +Nimrod Adar, [contact me](mailto:nimrod@shore.co.il) or visit my +[website](https://www.shore.co.il/). Patches are welcome via [git +send-email](http://git-scm.com/book/en/v2/Git-Commands-Email). The repository is +located at <https://www.shore.co.il/git/>.