Skip to content

Commit c64a34b

Browse files
authored
Update README.md to comprehensively explain what the package do (#253)
Updated description fort better understand and sentence structure.
1 parent 53d57ba commit c64a34b

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
1-
# Package to create releases and changelogs in laravel
1+
# Package to create releases and changelogs in Laravel
22

33
[![Latest Version on Packagist](https://img.shields.io/packagist/v/lightszentip/laravel-release-changelog-generator.svg?style=flat-square)](https://packagist.org/packages/lightszentip/laravel-release-changelog-generator)
44
[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/lightszentip/laravel-release-changelog-generator/run-tests?label=tests)](https://github.com/lightszentip/laravel-release-changelog-generator/actions?query=workflow%3Arun-tests+branch%3Amain)
55
[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/lightszentip/laravel-release-changelog-generator/Fix%20PHP%20code%20style%20issues?label=code%20style)](https://github.com/lightszentip/laravel-release-changelog-generator/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
66
[![Total Downloads](https://img.shields.io/packagist/dt/lightszentip/laravel-release-changelog-generator.svg?style=flat-square)](https://packagist.org/packages/lightszentip/laravel-release-changelog-generator) [![PHP-CS-Fixer](https://github.com/lightszentip/laravel-release-changelog-generator/actions/workflows/quality-check.yml/badge.svg?branch=main)](https://github.com/lightszentip/laravel-release-changelog-generator/actions/workflows/quality-check.yml) [![Update Changelog GIT](https://github.com/lightszentip/laravel-release-changelog-generator/actions/workflows/update-changelog-main.yml/badge.svg)](https://github.com/lightszentip/laravel-release-changelog-generator/actions/workflows/update-changelog-main.yml)
77

8-
This package add a changelog management over command line and a version release management. So you can add new changelog
9-
items and if you release, the changelog ist update with new version and the version file also. So it is easy to manage a
10-
customer changelog.
8+
This package adds changelog management over the command line and version release management. You can add new changelog items, and if you release, the changelog is updated with the new version and the version file. Thus, it is easy to manage a customer changelog.
119

12-
The changelog is a json file that can easy integrate into a controller to present to end customer.
10+
The changelog is a JSON file that can easily be integrated into a controller to present to the end customer.
1311

1412
See [ROADMAP](ROADMAP.md) for new functions.
1513

@@ -26,7 +24,7 @@ See [ROADMAP](ROADMAP.md) for new functions.
2624
0.4.x | >=8.2 | 11
2725
## Installation
2826

29-
You can install the package via composer:
27+
You can install the package via Composer:
3028

3129
```bash
3230
composer require lightszentip/laravel-release-changelog-generator
@@ -41,7 +39,7 @@ php artisan vendor:publish --tag=resources
4139

4240
## Usage
4341

44-
If the command use without arguments, the command line create a ask for all necessary arguments.
42+
If the command is used without arguments, the command line creates an ask for all necessary arguments.
4543

4644
### Create a new changelog item:
4745

@@ -57,7 +55,7 @@ You can find the result in resources/.changes/changelog.json
5755
php artisan changelog:release --releasename="My First Release" --type=patch
5856
```
5957

60-
This update the version.yml to the next patch vesion and add in the changelog.json a new release with all current
58+
This updates the version.yml to the next patch version and add in the changelog.json a new release with all current
6159
changelog items.
6260

6361
### Update CHANGELOG.md file:
@@ -68,7 +66,7 @@ This will update the CHANGELOG.md file in the root with your changes.
6866
php artisan changelog:generate-md
6967
```
7068

71-
### Get version in the application
69+
### Get the version in the application
7270

7371
#### Blade
7472

@@ -77,7 +75,7 @@ php artisan changelog:generate-md
7775
```
7876

7977
To get a special format for the version, you find in the 'releasechangelog.php' in the config dir the item '
80-
version_formats'. You can add new formats and/or change the existing. To use it:
78+
version_formats'. You can add new formats and/or change the existing ones. To use it:
8179

8280
```php
8381
@releasechangelog('full')
@@ -93,7 +91,7 @@ app('releasechangelog.version')->showVersion($format)
9391

9492
````prerelease```` set to false to remove the "rc" part from version
9593

96-
To use antother pre release name as 'rc', change it on version.yml direct.
94+
To use another pre-release name as 'rc', change it on version.yml direct.
9795

9896
### Example Result
9997

0 commit comments

Comments
 (0)