Skip to content

Commit

Permalink
added changelog from v2
Browse files Browse the repository at this point in the history
  • Loading branch information
nemoitis committed Mar 19, 2024
1 parent 9a3c203 commit e51aed5
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 6 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md → CHANGELOG-1.x.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

All notable changes to `svg-avatar-generator` will be documented in this file.
All notable changes to `svg-avatar-generator` **v1.x** will be documented in this file.

## 1.4.2

Expand Down
11 changes: 11 additions & 0 deletions CHANGELOG-2.x.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Changelog

All notable changes to `svg-avatar-generator` **v2.x** will be documented in this file.

## 2.0.0

- Laravel 11 supports only.
- New validator for `foreground` and `gradient_colors` config.
- Dropped support for named colors, e.g. red, green in `foreground` and `gradient_colors`.
- Use `rules()` static method instead of `$rules` property to define validation rules.
- New `GradientColorSet` rule class to validate gradient colors structure.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ Well, this one has some subtle but nifty advantages over available packages, her

## Requirements

- PHP >= 8.1
- Laravel >= 9.0
- PHP >= 8.2
- Laravel >= 11.0

## Installation

Expand All @@ -34,12 +34,17 @@ Install the package via composer:
composer require sowrensen/svg-avatar-generator
```

> [!CAUTION]
> **Breaking change**: Named color support, e.g. red, green in `foreground` and `gradient_colors` is dropped since version 2.0.
> If you're using such names in config or in code, you should change them to hexadecimal code or keep using
> version 1.x releases.
Optionally, you can publish the config file with:

```bash
php artisan vendor:publish --tag="svg-avatar-generator-config"
```
> [!WARNING]
> [!IMPORTANT]
> You should republish the config file after updating.
## Usage
Expand Down Expand Up @@ -73,7 +78,7 @@ class User extends Model
}
```

> [!NOTE]
> [!TIP]
> If your accessor is different from the original attribute, you might want to put it in `$appends` array so
> that it loads automatically with your model.
Expand Down Expand Up @@ -156,7 +161,7 @@ composer test

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
Please see respective `CHANGELOG-x.x` file for more information on what has changed recently.

## License

Expand Down

0 comments on commit e51aed5

Please sign in to comment.