|
1 | 1 | # BizkitVersioningBundle |
2 | 2 |
|
3 | | -[](https://github.com/HypeMC/versioning-bundle/actions) |
4 | 3 | [](https://packagist.org/packages/bizkit/versioning-bundle) |
5 | | -[](https://packagist.org/packages/bizkit/versioning-bundle) |
| 4 | +[](https://github.com/HypeMC/versioning-bundle/actions) |
6 | 5 | [](https://codecov.io/gh/HypeMC/versioning-bundle) |
| 6 | +[](https://packagist.org/packages/bizkit/versioning-bundle) |
7 | 7 |
|
8 | 8 | Symfony bundle which provides a way to version your application using various versioning strategies. |
9 | 9 |
|
10 | 10 |  |
11 | 11 |
|
12 | 12 | ## Features |
13 | 13 |
|
14 | | -* Stores the application's version & release date into a compliant YAML or XML Symfony container configuration file |
15 | | -* Automatically imports the file with the parameters into Symfony's container |
16 | | -* Supports multiple versioning strategies & creating custom ones |
17 | | -* Includes a console command for incrementing the version using the configured versioning strategy |
18 | | -* The command automatically commits the version file & optionally creates a tag if a VCS handler is configured |
19 | | -* Supports the Git VCS & creating custom VCS handlers |
| 14 | +- Stores the application's version & release date into a compliant YAML or XML Symfony container configuration file |
| 15 | +- Automatically imports the file with the parameters into Symfony's container |
| 16 | +- Supports multiple versioning strategies & creating custom ones |
| 17 | +- Includes a console command for incrementing the version using the configured versioning strategy |
| 18 | +- The command automatically commits the version file & optionally creates a tag if a VCS handler is configured |
| 19 | +- Supports the Git VCS & creating custom VCS handlers |
20 | 20 |
|
21 | 21 | ## Requirements |
22 | 22 |
|
23 | | -* [PHP 7.2](http://php.net/releases/7_2_0.php) or greater |
24 | | -* [Symfony 4.4](https://symfony.com/roadmap/4.4) or [Symfony 5.2](https://symfony.com/roadmap/5.2) or greater |
| 23 | +- [PHP 7.2](http://php.net/releases/7_2_0.php) or higher |
| 24 | +- [Symfony 4.4](https://symfony.com/roadmap/4.4) or [Symfony 5.2](https://symfony.com/roadmap/5.2) or higher |
25 | 25 |
|
26 | 26 | ## Installation |
27 | 27 |
|
28 | | -1. Require the bundle with [Composer](https://getcomposer.org/): |
| 28 | +1. Require the bundle using [Composer](https://getcomposer.org/): |
29 | 29 |
|
30 | 30 | ```sh |
31 | 31 | composer require bizkit/versioning-bundle |
32 | 32 | ``` |
33 | 33 |
|
34 | | -1. Create the bundle configuration file under `config/packages/bizkit_versioning.yaml`. Here is a reference configuration file: |
| 34 | +1. Create a configuration file under `config/packages/bizkit_versioning.yaml`. Here's a reference configuration: |
35 | 35 |
|
36 | 36 | ```yaml |
37 | 37 | bizkit_versioning: |
@@ -84,7 +84,8 @@ Symfony bundle which provides a way to version your application using various ve |
84 | 84 | path_to_executable: null |
85 | 85 | ``` |
86 | 86 |
|
87 | | -1. Enable the bundle in `config/bundles.php` by adding it to the array: |
| 87 | +1. If your project doesn't use [Symfony Flex](https://github.com/symfony/flex), enable the bundle in |
| 88 | + `config/bundles.php` by adding it to the array: |
88 | 89 |
|
89 | 90 | ```php |
90 | 91 | Bizkit\VersioningBundle\BizkitVersioningBundle::class => ['all' => true], |
@@ -229,12 +230,12 @@ bizkit_versioning: |
229 | 230 |
|
230 | 231 | ## Versioning |
231 | 232 |
|
232 | | -This project adheres to [Semantic Versioning 2.0.0](http://semver.org/). |
| 233 | +This project follows [Semantic Versioning 2.0.0](http://semver.org/). |
233 | 234 |
|
234 | | -## Reporting issues |
| 235 | +## Reporting Issues |
235 | 236 |
|
236 | | -Use the [issue tracker](https://github.com/HypeMC/versioning-bundle/issues) to report any issues you might have. |
| 237 | +Use the [issue tracker](https://github.com/HypeMC/versioning-bundle/issues) to report any issues you encounter. |
237 | 238 |
|
238 | 239 | ## License |
239 | 240 |
|
240 | | -See the [LICENSE](LICENSE) file for license rights and limitations (MIT). |
| 241 | +See the [LICENSE](LICENSE) file for details (MIT). |
0 commit comments