Skip to content

Commit 04063bd

Browse files
committed
Update README.md
1 parent 5bfe7f2 commit 04063bd

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,29 @@
1010
[![License](https://poser.pugx.org/tm/tooly-composer-script/license)](https://packagist.org/packages/tm/tooly-composer-script)
1111
[![Gitter](https://badges.gitter.im/tommy-muehle/tooly-composer-script.svg)](https://gitter.im/tommy-muehle/tooly-composer-script?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
1212

13-
With the tooly [composer-script](https://getcomposer.org/doc/articles/scripts.md) aka hook you can manage needed PHAR files for quality assurance, such as PHPUnit or phpmd, in your project's composer.json. Every PHAR file will be saved in the [composer binary directory](https://getcomposer.org/doc/articles/vendor-binaries.md).
13+
With tooly [composer-script](https://getcomposer.org/doc/articles/scripts.md) you can version needed PHAR files in your project's composer.json without adding them directly to a VCS,
14+
* to save disk space
15+
* to be sure that all developers in your project get the required toolchain
16+
* to prepare a CI/CD System
17+
* (optional) to automatically check the [GPG signature verification](https://www.gnupg.org/gph/en/manual/x135.html) for each tool
1418

15-
So you can be sure that all developers in your project get the required PHAR tools in the needed version with nothing more as composer. Optional with [GPG signature verification](https://www.gnupg.org/gph/en/manual/x135.html) for each tool.
19+
Every PHAR file will be saved in the [composer binary directory](https://getcomposer.org/doc/articles/vendor-binaries.md).
1620

1721
## Example
1822

19-
For an quick example look at the [composer.json](composer.json#L57-L76) here.
23+
An real example can be found [here](composer.json#L57-L76).
24+
25+
## Requirements
26+
27+
* PHP >= 5.6
28+
* Composer
2029

2130
## Install
2231

23-
To use the script just do the following single command:
24-
25-
*Note: There are no further dependencies in this library. Only PHP.*
32+
To use the script execute the following command:
2633

2734
```
28-
composer require tm/tooly-composer-script
35+
composer require --dev tm/tooly-composer-script
2936
```
3037

3138
Then add the script in the composer.json under *"scripts"* with the event names you want to trigger.
@@ -111,6 +118,8 @@ But is also useful if some require-dev library has one of the tools as own requi
111118
This parameter means that this phar is only needed in developing mode.
112119
So the command ```composer [install|update] --no-dev``` ignores this phar tool.
113120

121+
**Note: Therefore tooly must be a [no-dev requirement](https://getcomposer.org/doc/04-schema.md#require)**
122+
114123
## Postcardware
115124

116125
You're free to use this package (it's [MIT-licensed](LICENSE)), but if it makes you happy it would be a great pleasure for me if you send a postcard from your hometown to me.

0 commit comments

Comments
 (0)