diff options
| author | Teddy Wing | 2015-09-27 14:45:01 -0400 |
|---|---|---|
| committer | Teddy Wing | 2015-09-27 14:48:18 -0400 |
| commit | 4941dce09c968e17d3355e035d85960646855f7f (patch) | |
| tree | 0c9f1ba565faf0b04faa8629bebd19c0cd55ca10 | |
| parent | 8ed316c725f9c53c093a5d85a1f1655c0dba3616 (diff) | |
| download | git-hook-pre-commit-python-javascript-syntax-linter-4941dce09c968e17d3355e035d85960646855f7f.tar.bz2 | |
Add README
Includes a short description, requirements, installation instructions,
testing information, and license information.
| -rw-r--r-- | README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..887fa0a --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +git-hook-pre-commit-python-javascript-syntax-linter +=================================================== + +A git pre-commit hook that lints Python and JavaScript files to be committed. If +syntax errors are present, the commit is aborted. + + +## Requirements +* [flake8](https://pypi.python.org/pypi/flake8/2.4.1) +* [jshint](https://www.npmjs.com/package/jshint) + + +## Installation + + cp pre-commit /your/project/path/.git/hooks + chmod +x /your/project/path/.git/hooks/pre-commit + +If you already have a `pre-commit` hook, copy the relevant lines to your +`pre-commit` script. + + +## Tests +Requires `git` and `prove`. To run the tests use: + + $ make + + +## License +Licensed under the MIT license. See the included LICENSE file. |