From 78ddd2df8a7089ff02afd29c00b37739722d4224 Mon Sep 17 00:00:00 2001
From: jeffshek <jeffshek@gmail.com>
Date: Wed, 8 Jun 2016 00:57:07 -0400
Subject: [PATCH] update documentation, fix some spacing issues

---
 README.rst                               |  4 ++--
 {{cookiecutter.project_slug}}/README.rst | 20 ++++++++++++++++++++
 2 files changed, 22 insertions(+), 2 deletions(-)

diff --git a/README.rst b/README.rst
index 915063794..dfc16006e 100644
--- a/README.rst
+++ b/README.rst
@@ -50,6 +50,7 @@ Optional Integrations
 
 * Serve static files from Amazon S3 or Whitenoise_
 * Configuration for Celery_
+* Configuration for Precommit-Hooks_
 * Integration with MailHog_ for local email testing
 * Integration with Sentry_ for error logging
 * Integration with NewRelic_ for performance monitoring
@@ -72,7 +73,7 @@ Optional Integrations
 .. _docker-compose: https://www.github.com/docker/compose
 .. _Opbeat: https://opbeat.com/
 .. _PythonAnywhere: https://www.pythonanywhere.com/
-
+.. _Precommit-Hooks_: http://pre-commit.com/
 
 Constraints
 -----------
@@ -128,7 +129,6 @@ Answer the prompts with your own desired options_. For example::
     use_heroku [n]: n
     use_grunt [n]: y
     use_precommit_hooks [n]: n
-    
     Select open_source_license:
     1 - MIT
     2 - BSD
diff --git a/{{cookiecutter.project_slug}}/README.rst b/{{cookiecutter.project_slug}}/README.rst
index 55a520c54..912a800a6 100644
--- a/{{cookiecutter.project_slug}}/README.rst
+++ b/{{cookiecutter.project_slug}}/README.rst
@@ -73,6 +73,26 @@ Please note: For Celery's import magic to work, it is important *where* the cele
 
 {% endif %}
 
+{% if cookiecutter.use_precommit_hooks == "y" %}
+
+Pre-Commit Hooks
+^^^^^^^^^^^^^^^^
+
+To use pre-commit hooks when committing messages, after initial git commit, run
+.. code-block:: bash
+
+    pre-commit install
+
+Now on each commit message, this will run whatever commit plugins have been enabled. To skip a pre-commit hook, add a -n (no verify) parameter at the end of your commit message.
+
+.. code-block:: bash
+
+    git commit -m "i put a really bad pdb in here" -n
+
+
+{% endif %}
+
+
 {% if cookiecutter.use_mailhog == "y" %}
 
 Email Server