Skip to content

Commit 58952a2

Browse files
committed
Update README
1 parent 66ea955 commit 58952a2

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
11
# BizkitVersioningBundle
22

3-
[![Build Status](https://github.com/HypeMC/versioning-bundle/workflows/Tests/badge.svg)](https://github.com/HypeMC/versioning-bundle/actions)
43
[![Latest Stable Version](https://poser.pugx.org/bizkit/versioning-bundle/v/stable)](https://packagist.org/packages/bizkit/versioning-bundle)
5-
[![License](https://poser.pugx.org/bizkit/versioning-bundle/license)](https://packagist.org/packages/bizkit/versioning-bundle)
4+
[![Build Status](https://github.com/HypeMC/versioning-bundle/workflows/Tests/badge.svg)](https://github.com/HypeMC/versioning-bundle/actions)
65
[![Code Coverage](https://codecov.io/gh/HypeMC/versioning-bundle/branch/1.x/graph/badge.svg)](https://codecov.io/gh/HypeMC/versioning-bundle)
6+
[![License](https://poser.pugx.org/bizkit/versioning-bundle/license)](https://packagist.org/packages/bizkit/versioning-bundle)
77

88
Symfony bundle which provides a way to version your application using various versioning strategies.
99

1010
![Showcase](showcase.gif)
1111

1212
## Features
1313

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
2020

2121
## Requirements
2222

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
2525

2626
## Installation
2727

28-
1. Require the bundle with [Composer](https://getcomposer.org/):
28+
1. Require the bundle using [Composer](https://getcomposer.org/):
2929

3030
```sh
3131
composer require bizkit/versioning-bundle
3232
```
3333

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:
3535
3636
```yaml
3737
bizkit_versioning:
@@ -84,7 +84,8 @@ Symfony bundle which provides a way to version your application using various ve
8484
path_to_executable: null
8585
```
8686
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:
8889

8990
```php
9091
Bizkit\VersioningBundle\BizkitVersioningBundle::class => ['all' => true],
@@ -229,12 +230,12 @@ bizkit_versioning:
229230
230231
## Versioning
231232
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/).
233234
234-
## Reporting issues
235+
## Reporting Issues
235236
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.
237238
238239
## License
239240
240-
See the [LICENSE](LICENSE) file for license rights and limitations (MIT).
241+
See the [LICENSE](LICENSE) file for details (MIT).

0 commit comments

Comments
 (0)