Skip to content

Commit 306776f

Browse files
committed
Add instructions on how to build php-semver-checker.phar in the README.md.
1 parent e297087 commit 306776f

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,15 @@ As this is still an alpha package, it is not suggested to include `php-semver-ch
2020
2. `php composer.phar create-project tomzx/php-semver-checker --stability=dev` will clone to a new php-semver-checker folder in your current working directory
2121
3. `git clone https://github.com/tomzx/php-semver-checker.git` and `php composer.phar install` in the newly cloned directory.
2222

23+
See the example section for examples of how to use the tool.
24+
25+
### Building `php-semver-checker.phar`
26+
First, make sure you have [box](https://github.com/box-project/box2) installed. Then, in the base directory, you can run the following command which will generate the `php-semver-checker.phar` file.
27+
28+
```
29+
box build
30+
```
31+
2332
## Current ruleset & verification codes
2433

2534
See [`docs/Ruleset.md`](docs/Ruleset.md) for an exhaustive list of currently supported (and to come) ruleset.
@@ -117,7 +126,7 @@ Trait (MAJOR)
117126
[Scanned files] Before: 26, After: 27, Identical: 0
118127
Time: 1.43 seconds, Memory: 5.123 MB
119128
```
120-
129+
121130
## License
122131

123132
The code is licensed under the [MIT license](http://choosealicense.com/licenses/mit/). See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)