third-party/pre-commit
1
0
Fork 0
mirror of https://github.com/pre-commit/pre-commit.git synced 2026-02-19 09:04:41 +04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Misc readme changes.

Browse source
This commit is contained in:
Anthony Sottile 2014-08-14 15:34:31 -07:00
parent 1cfb9e76a3
commit 3cac9489b3
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -49,7 +49,7 @@ Non Administrative Installation:
System Level Install: System Level Install:
sudo curl https://bootstrap.pypa.io/get-pip.py | python - pre-commit curl https://bootstrap.pypa.io/get-pip.py | sudo python - pre-commit
In a Python Project, add the following to your requirements.txt (or requirements-dev.txt): In a Python Project, add the following to your requirements.txt (or requirements-dev.txt):
@ -86,8 +86,8 @@ trailing-whitespace hook.
## Usage ## Usage
run `pre-commit install` to install pre-commit into your git hooks. pre-commit run `pre-commit install` to install pre-commit into your git hooks. pre-commit
will now run on every commit. Everytime you clone a project using pre-commit will now run on every commit. Every time you clone a project using pre-commit
running install should always be the first thing you do. running `pre-commit install` should always be the first thing you do.
If you want to manually run all pre-commit hooks on a repository, run If you want to manually run all pre-commit hooks on a repository, run
`pre-commit run --all-files`. To run individual hooks use `pre-commit run --all-files`. To run individual hooks use
@ -103,7 +103,7 @@ and build a copy of node.
pre-commit currently supports hooks written in JavaScript (node), Python, Ruby pre-commit currently supports hooks written in JavaScript (node), Python, Ruby
and system installed scripts. As long as your git repo is an installable package and system installed scripts. As long as your git repo is an installable package
(gem, npm, pypi, etc) or exposes a executable, it can be used with pre-commit. (gem, npm, pypi, etc) or exposes an executable, it can be used with pre-commit.
Each git repo can support as many languages/hooks as you want. Each git repo can support as many languages/hooks as you want.
An executable must satisfy the following things: An executable must satisfy the following things: