Skip to content

Commit cee4911

Browse files
committed
Add Upgrade notice
1 parent f9e1304 commit cee4911

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,6 @@ JsonApiClient is a PHP Library to validate and handle the response body from a [
1010

1111
Format: [JSON API 1.0](http://jsonapi.org/format/1.0/)
1212

13-
#### Attention
14-
15-
Version 0.6.1 and below interprets the pagination links wrong. Make sure you are using the latest version of JsonApiClient. See [#19](https://github.com/Art4/json-api-client/issues/19), [#23](https://github.com/Art4/json-api-client/pull/23) and [#26](https://github.com/Art4/json-api-client/pull/26) for more information.
16-
1713
### WIP: Goals for 1.0
1814

1915
* [x] Be 100% JSON API 1.0 spec conform
@@ -23,6 +19,26 @@ Version 0.6.1 and below interprets the pagination links wrong. Make sure you are
2319
* [x] Handle/validate a client request body
2420
* [ ] Refactore and remove the deprecated code
2521

22+
### Upgrade notice
23+
24+
JsonApiClient can be considered as stable and version 0.10 will be the last development version.
25+
26+
After version 0.8 there where no breaking changes. Every change was backward compatible and every functionality that will be removed in future now only triggers a deprecated warning.
27+
28+
After version 0.10 is released all deprecated code will be removed and version 1.0 will be released.
29+
30+
This simply means for you:
31+
32+
1. Update to version 0.10
33+
2. Make your code deprecation free
34+
3. You are now ready for upgrading to version 1.0 without breaking your code
35+
36+
(Compare the [Symfony upgrade documentation](https://symfony.com/doc/current/setup/upgrade_major.html))
37+
38+
#### Attention for older versions
39+
40+
Version 0.6.1 and below interprets the pagination links wrong. Make sure you are using the latest version of JsonApiClient. See [#19](https://github.com/Art4/json-api-client/issues/19), [#23](https://github.com/Art4/json-api-client/pull/23) and [#26](https://github.com/Art4/json-api-client/pull/26) for more information.
41+
2642
## Install
2743

2844
Via Composer

0 commit comments

Comments
 (0)