Skip to content

Commit f87a2cb

Browse files
committed
Add UPGRADING.md
1 parent e0ed2a4 commit f87a2cb

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
66

77
## [Unreleased]
88

9+
Please see [UPGRADING](UPGRADING.md) for details on how to upgrade.
10+
911
### Added
1012

1113
* Added `Item::mergeAppends`, `Item::mergeCasts`, `Item::mergeFillable` and `Item::mergeGuarded`.

UPGRADING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Upgrading swisnl/json-api-client
2+
3+
## From 1.x to 2.x
4+
5+
1. If you are using Laravel, you should remove `swisnl/json-api-client` and install `swisnl/json-api-client-laravel` instead. If you are not using Laravel, you can simply bump the dependency constraint to `^2.0`;
6+
2. Make sure you don't have references to `Jenssegers\Model\Model`. This dependency has been dropped in favor of `Swis\JsonApi\Client\Item`, which is mostly the same.
7+
3. Read through the [CHANGELOG](CHANGELOG.md) for other changes affecting you.

0 commit comments

Comments
 (0)