docs: add section about post-merge compiling

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
@@ -114,23 +124,6 @@ vertical split action it will open the buffer in a new `vsplit`
     -- the results window, The `input` will be passed in, so you can filter
     -- your results with the value from the prompt
     function(input)
-  vim.ivy.run(
-    -- The name given to the results window and displayed to the user
-    "Title",
-    -- Call back function to get all the candidates that will be displayed in
-    -- the results window, The `input` will be passed in, so you can filter
-    -- your results with the value from the prompt
-    function(input)
-      return {
-        { content = "One" },
-        { content = "Two" },
-        { content = "Three" },
-      }
-    end,
-    -- Action callback that will be called on the completion or peek actions.
-    -- The currently selected item is passed in as the result.
-    function(result) vim.cmd("edit " .. result) end
-  )
       return {
         { content = "One" },
         { content = "Two" },

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