From bc6c356a6047d2ca6f074dbf052025feb95c0002 Mon Sep 17 00:00:00 2001
From: Bart Stefanski <contact@bstefanski.com>
Date: Fri, 21 Apr 2023 18:10:15 +0200
Subject: [PATCH] chore: add guide on how to install conventional commits hook
 on local machine

---
 README.md | 37 ++++++++++++++++++++++++++-----------
 1 file changed, 26 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index f0683a6..c21a3c6 100644
--- a/README.md
+++ b/README.md
@@ -33,17 +33,26 @@ With this template, you get all the awesomeness you need:
 
 ## Table of Contents
 
-- [Features](#-features)
-- [Getting Started](#-getting-started)
-- [Deployment](#-deployment)
-- [Scripts Overview](#-scripts-overview)
-- [Coupling Graph](#-coupling-graph)
-- [Testing](#-testing)
-- [Styling and Design System](#-styling-and-design-system)
-- [State Management](#-state-management)
-- [ChatGPT Code Review](#-chatgpt-code-review)
-- [Contribution](#-contribution)
-- [License](#-license)
+- [Next.js Enterprise Boilerplate](#nextjs-enterprise-boilerplate)
+  - [📚 Features](#-features)
+  - [Table of Contents](#table-of-contents)
+  - [🎯 Getting Started](#-getting-started)
+  - [🚀 Deployment](#-deployment)
+  - [📃 Scripts Overview](#-scripts-overview)
+  - [🔗 Coupling Graph](#-coupling-graph)
+  - [🧪 Testing](#-testing)
+    - [Running Tests](#running-tests)
+    - [Acceptance Tests](#acceptance-tests)
+    - [Smoke Testing](#smoke-testing)
+  - [🎨 Styling and Design System](#-styling-and-design-system)
+    - [CVA - A New Approach to Variants](#cva---a-new-approach-to-variants)
+  - [💾 State Management](#-state-management)
+    - [Zustand](#zustand)
+    - [Jotai](#jotai)
+    - [Recoil](#recoil)
+  - [🤖 ChatGPT Code Review](#-chatgpt-code-review)
+  - [🤝 Contribution](#-contribution)
+  - [📜 License](#-license)
 
 ## 🎯 Getting Started
 
@@ -70,6 +79,12 @@ yarn dev
 
 4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
 
+5. This project uses a git hook to enforce [conventional commits](https://github.com/qoomon/git-conventional-commits). To install the git hook, run the following command in the root directory of the project:
+
+```sh
+brew install pre-commit
+pre-commit install -t commit-msg
+```
 
 ## 🚀 Deployment