From 0bdb7bf51f93ce0f5ae8d1975213408a741d1a9d Mon Sep 17 00:00:00 2001
From: Eden Kirin <eden@ekirin.com>
Date: Fri, 1 Sep 2023 09:51:08 +0200
Subject: [PATCH] Add readme

---
 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..a95c65e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# git-hooks
+
+## Installation
+
+1. Clone repository
+
+```
+git clone https://gitea.ekirin.com/Intis/git-hooks.git
+```
+
+### Use in single repository
+
+1. Copy `intis-hooks` directory content to `your-repo-dir/.git/hooks` directory.
+
+2. Make sure `prepare-commit-msg` is executable. If not, make it: `chmod +x prepare-commit-msg`.
+
+### Use globally, as default hooks
+
+1. Create `~/.git-templates`
+
+2. Run the command:
+
+```
+git config --global init.templateDir '~/.git-templates'
+```
+
+3. Reinitialize existing git repos you wish to use this in: "git init"
+
+4. Rename `your-repo-dir/.git/intis-hooks` to `your-repo-dir/.git/hooks`