diff --git a/Readme.md b/Readme.md index 23bac73..300bba3 100644 --- a/Readme.md +++ b/Readme.md @@ -18,7 +18,21 @@ Add the plugin to your build with the following in `project/plugins.sbt`: addSbtPlugin("uk.co.randomcoding" % "sbt-git-hooks" % "0.2.0") ``` -Then run the task `writeHooks` to copy the hooks into `.git/hooks` +Then run the task `writeHooks` to copy the hooks into `.git/hooks`. + +**Note**: Everytime there are modifications to custom git hooks, you are expected to run this `writeHooks` sbt task. This requirement however could be automated by invoking this task on every sbt load. To do so add following code to `build.sbt`: +```scala +lazy val startupTransition: State => State = { s: State => + "writeHooks" :: s +} + +onLoad in Global := { + val old = (onLoad in Global).value + startupTransition compose old +} +``` + +Now if you run `sbt` in your repository directory, `writeHooks` task will automically be called and your updated custom git hooks will be copied to `.git/hooks` out-of-the-box. ### Licence