Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastianfeldmann committed Dec 13, 2023
1 parent 5d9025d commit fd0ee6c
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,28 @@
[![Downloads](https://img.shields.io/packagist/dt/captainhook/hook-installer.svg?v1)](https://packagist.org/packages/captainhook/plugin-composer)
[![License](https://poser.pugx.org/captainhook/hook-installer/license.svg?v=1)](https://packagist.org/packages/captainhook/plugin-composer)

`HookInstaller` is a `Composer Plugin` for [CaptainHook](https://github.com/captainhookphp/captainhook) it takes
care of activating your local git hooks.
*HookInstaller* is a *Composer* plugin for [CaptainHook](https://github.com/captainhookphp/captainhook) it takes
care of activating your local git hooks after `composer install` or `composer update`.
If you want to make sure your teammates activate their hooks, install this plugin
and you don't have to remind them anymore.

For more information about `CaptainHook` visit the [Website](http://captainhook.info/).

## Installation:

As this is a composer-plugin you should use composer to install it.
As this is a *Composer* plugin you should use *Composer* to install it.

```bash
$ composer require --dev captainhook/hook-installer
```
For this to work you must have `CaptainHook` installed already.
If you need help installing `CaptainHook` have a look at the Captain´s [README](https://github.com/captainhookphp/captainhook)

Everything else should happen automagically.

## Customize

You can set the path to your `CaptainHook` configuration file.
If you choose to not put your configuration in the default location you can set the path to your `CaptainHook` configuration file.
If you installed `CaptainHook` without using any of its Composer packages `captainhook/captainhook`
or `captainhook/captainhook-phar` you have to set the path to the executable.
All extra config settings are optional and if you are using the default settings you do not have to
Expand All @@ -32,8 +36,9 @@ configure anything to make it work.
{
"extra": {
"captainhook": {
"config": "hooks.json",
"config": "config/captainhook.json",
"exec": "tools/captainhook.phar",
"force-install": true,
"disable-plugin": false
}
}
Expand Down

0 comments on commit fd0ee6c

Please sign in to comment.