From e58af1a09295eb9ba65296cbb2b8a2d38f98e9e4 Mon Sep 17 00:00:00 2001
From: Waylon Walker <walker_waylon_s@cat.com>
Date: Fri, 25 Jun 2021 08:22:59 -0500
Subject: [PATCH] Add pre-commit intstructions

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 74df945..579edc9 100644
--- a/README.md
+++ b/README.md
@@ -31,3 +31,11 @@ This pipeline run daily at `0:0` to generate a `packages.json`,
 ``` bash
 pip install -e ".[dev]"
 ```
+
+This project includes a `pre-commit-config`, this ensures that each commit made
+to the project passes all checks that are also ran in CI. To setup pre-commit
+in your development environment run the follow command.
+
+``` bash
+pre-commit install
+```