Skip to content

Commit 0b04f1a

Browse files
Update composer extra configuration
1 parent 513aa14 commit 0b04f1a

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Composer-Plugin for [CaptainHook](https://github.com/captainhookphp/captainhook)
22

3-
This is a composer-plugin that installs _CaptainHook_ and the corresponding git hooks. For more information visit its [Website](https://github.com/captainhookphp/captainhook).
3+
This is a composer-plugin that makes sure your team mates install the git hooks. For more information visit its [Website](https://github.com/captainhookphp/captainhook).
44

55
[![Latest Stable Version](https://poser.pugx.org/captainhook/plugin-composer/v/stable.svg?v=1)](https://packagist.org/packages/captainhook/plugin-composer)
66
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.1-8892BF.svg)](https://php.net/)
@@ -19,24 +19,21 @@ Everything else will happen automagically.
1919

2020
## Customize
2121

22-
You can set a custom name for your hook configuration and a custom path to your .git directory
23-
if it is not located in the same directory as your *composer.json* file.
24-
Just add these values to your *composer.json* in the *extra* section first.
22+
You can set a custom name for your hook configuration.
23+
If you want to use the PHAR release of `CaptainHook` you can configure the path the executable.
2524
```json
2625
{
2726
"extra": {
28-
"captainhook-config": "hooks.json",
29-
"captainhook-git-dir": "../.git"
30-
}
31-
27+
"captainhook": {
28+
"config": "hooks.json",
29+
"exec": "tools/captainhook.phar",
30+
"disable-plugin": false
31+
}
32+
}
3233
}
3334

3435
```
3536

36-
If you want to see the installation in action have a look at this short installation video.
37-
38-
[![Install demo](http://img.youtube.com/vi/agwTZ0jhDDs/0.jpg)](https://www.youtube.com/watch?v=agwTZ0jhDDs)
39-
4037
## A word of warning
4138

4239
It is still possible to commit without invoking the hooks.

0 commit comments

Comments
 (0)