Merge pull request #27 from pre-commit/update_readme

Update readme
This commit is contained in:
asottile 2014-03-16 20:00:49 -07:00
commit 601e643960

View file

@ -1,6 +1,17 @@
[![Build Status](https://travis-ci.org/pre-commit/pre-commit-hooks.png?branch=master)](https://travis-ci.org/pre-commit/pre-commit-hooks)
pre-commit pre-commit
========== ==========
A framework for managing and maintaining multi-language pre-commit hooks. A framework for managing and maintaining multi-language pre-commit hooks.
Some out-of-the-box hooks: https://github.com/pre-commit/pre-commit-hooks Some out-of-the-box hooks: https://github.com/pre-commit/pre-commit-hooks
## What is a "pre-commit"
A pre-commit is some code that runs before commiting code to do some spot-checking for some basic programming mistakes.
## Why make this project?
We noticed that when creating a git repo it was not convenient to create pre-commit hooks. Often we resorted to copy/paste to include a set of useful hooks. https://github.com/causes/overcommit is an awesome project, but locked us into ruby and system packages -- which we wanted to avoid.