From 4941dce09c968e17d3355e035d85960646855f7f Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Sun, 27 Sep 2015 14:45:01 -0400
Subject: Add README

Includes a short description, requirements, installation instructions,
testing information, and license information.
---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

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.
-- 
cgit v1.2.3