Skip to content
This repository was archived by the owner on May 3, 2021. It is now read-only.

Commit b344ce5

Browse files
Update docs for 2.0.0 release (#10)
1 parent 0e25c47 commit b344ce5

File tree

3 files changed

+24
-0
lines changed

3 files changed

+24
-0
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
All notable changes to `ubient/laravel-flash-message` will be documented in this file
44

5+
## 2.0.0 - 2018-11-04
6+
- [Persist flash messages across redirects - #8](https://github.com/ubient/laravel-flash-message/issues/8)
7+
58
## 1.1.0 - 2018-11-03
69
- Add ability to assert flash messages
710

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,10 @@ You can run the test using:
8282
vendor/bin/phpunit
8383
```
8484

85+
## Upgrading
86+
87+
Please see [UPGRADING](UPGRADING.md) for details.
88+
8589
## Changelog
8690

8791
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

UPGRADING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Upgrading
2+
3+
Because there are many breaking changes an upgrade is not that easy. There are many edge cases this guide does not cover. We accept PRs to improve this guide.
4+
5+
## 1.x -> 2.x
6+
The mechanism for flashing messages was adjusted to persist across redirects ([#8](https://github.com/ubient/laravel-flash-message/issues/8)). As a result, one line was added to the `alert.blade.php` file.
7+
If you didn't publish/customize the template (as described [here in the README](README.md#customizing-the-template)) and use the template shipping with this package, you can safely update to 2.x without any issues.
8+
9+
If you did however publish the template, it will now be slightly out-of-date.
10+
To update it and make it compatible with 2.x, all you need to do is [add one line to your `alert.blade.php` file](https://github.com/ubient/laravel-flash-message/commit/0e25c47b889eb168146773912f7e7577a989e838#diff-efa7508de9508f985738c4dbb5b6147b).
11+
```php
12+
@if (session('flash_message') || session('status'))
13+
...
14+
// Add the following line..
15+
@php(session()->forget('flash_message'));
16+
@endif
17+
```

0 commit comments

Comments
 (0)