From 6bb0b121d6c8362de60dc9909d94711583704d9e Mon Sep 17 00:00:00 2001 From: Anthony Sottile Date: Sun, 16 Mar 2014 19:56:15 -0700 Subject: [PATCH] Update README to be more useful. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index b6d28bd3..e5e23b25 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,12 @@ pre-commit 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 + + +## 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.