Skip to content

Commit

Permalink
update with explanation on how it works
Browse files Browse the repository at this point in the history
  • Loading branch information
ezekg committed Nov 10, 2015
1 parent 827bff8 commit 375c5fe
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

Git plugin that helps prevent sensitive data from being committed by sniffing potential commits against regular expressions from a local `.githound.yml` file.

## How does it work?
It runs the output of `git diff -U0` through the Hound, which matches every _added_ or _modified_ line against your provided list of regular expressions. This runs in O(m*n) time (where m is the number of lines and n is the number of patterns), so be sure to commit often. But you should be doing that anyway, right?

## Installation
To install Hound, please use `go get`. If you don't have Go installed, [get it here](https://golang.org/dl/). If you would like to grab a precompiled binary, head over to the [releases](https://github.com/ezekg/git-hound/releases) page. The precompiled Hound binaries have no external dependencies.

Expand Down

0 comments on commit 375c5fe

Please sign in to comment.