From 2032d0748b3735957d86140814e76327205b167b Mon Sep 17 00:00:00 2001
From: Ade Attwood <adrian.attwood@marketdojo.com>
Date: Fri, 3 Mar 2023 07:18:08 +0000
Subject: [PATCH] docs: add section about post-merge compiling

---
 README.md         | 10 ++++++++++
 post-merge.sample |  5 +++++
 2 files changed, 15 insertions(+)
 create mode 100755 post-merge.sample

diff --git a/README.md b/README.md
index fb26ffc..e9e8d1e 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,16 @@ error: linker `cc` not found
   = note: No such file or directory (os error 2)
 ```
 
+To configure auto compiling you can use the [`post-merge`](./post-merge.sample)
+git hook to compile the library automatically when you update the package. This
+works well if you are managing your plugins via git. For an example
+installation you can run the following command. **NOTE:** This will overwrite
+any post-merge hooks you have already installed.
+
+```sh
+cp ./post-merge.sample ./.git/hooks/post-merge
+```
+
 ## Features
 
 ### Commands
diff --git a/post-merge.sample b/post-merge.sample
new file mode 100755
index 0000000..52363ab
--- /dev/null
+++ b/post-merge.sample
@@ -0,0 +1,5 @@
+#! /bin/bash
+
+# Automatically compile libivy.so when we pull down the repo.
+# https://github.com/AdeAttwood/ivy.nvim#compiling
+cargo build --release