Skip to content

Commit 9378b8e

Browse files
committed
Add a notice about wrong pagination links
1 parent e1abb62 commit 9378b8e

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
1-
# JSON API Client
1+
# JsonApiClient
22

33
[![Latest Version](https://img.shields.io/github/release/Art4/json-api-client.svg)](https://github.com/Art4/json-api-client/releases)
44
[![Software License](https://img.shields.io/badge/license-GPL2-brightgreen.svg)](LICENSE)
55
[![Build Status](https://travis-ci.org/Art4/json-api-client.svg?branch=master)](https://travis-ci.org/Art4/json-api-client)
66
[![Coverage Status](https://coveralls.io/repos/Art4/json-api-client/badge.svg?branch=master&service=github)](https://coveralls.io/github/Art4/json-api-client?branch=master)
77
[![Total Downloads](https://img.shields.io/packagist/dt/art4/json-api-client.svg)](https://packagist.org/packages/art4/json-api-client)
88

9-
JSON API Client is a PHP Library to validate and handle the response body from a [JSON API](http://jsonapi.org) Server.
9+
JsonApiClient is a PHP Library to validate and handle the response body from a [JSON API](http://jsonapi.org) Server.
1010

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

13+
#### Attention
14+
15+
Version 0.5 and below interprets the pagination links wrong. Make sure you are using the latest version of JsonApiClient. See [issue #19](https://github.com/Art4/json-api-client/issues/19) for more information.
16+
1317
### WIP: Goals for 1.0
1418

1519
* [x] Be 100% JSON API 1.0 spec conform
@@ -35,15 +39,15 @@ See the [documentation](docs/README.md).
3539

3640
```php
3741
// The Response body from a JSON API server
38-
$jsonapi_string = '{"meta":{"info":"Testing the JSON API Client."}}';
42+
$jsonapi_string = '{"meta":{"info":"Testing the JsonApiClient Library."}}';
3943

4044
$manager = new \Art4\JsonApiClient\Utils\Manager();
4145

4246
$document = $manager->parse($jsonapi_string);
4347

4448
if ($document->has('meta.info'))
4549
{
46-
echo $document->get('meta.info'); // "Testing the JSON API Client."
50+
echo $document->get('meta.info'); // "Testing the JsonApiClient Library."
4751
}
4852

4953
// List all keys
@@ -56,7 +60,7 @@ var_dump($document->getKeys());
5660

5761
### Using as validator
5862

59-
JSON API Client can be used as a validator for JSON API contents:
63+
JsonApiClient can be used as a validator for JSON API contents:
6064

6165
```php
6266
$wrong_jsonapi = '{"data":{},"meta":{"info":"This is wrong JSON API. `data` has to be `null` or containing at least `type` and `id`."}}';
@@ -75,7 +79,7 @@ else
7579

7680
### Extend the client
7781

78-
Need more functionality? Want to directly inject your model? Easily extend the client with the [Factory](docs/utils-factory.md).
82+
Need more functionality? Want to directly inject your model? Easily extend JsonApiClient with the [Factory](docs/utils-factory.md).
7983

8084
## Change log
8185

0 commit comments

Comments
 (0)