Skip to content

Commit 7bafc24

Browse files
committed
Rewrite goals, update README.md
1 parent cee4911 commit 7bafc24

File tree

2 files changed

+27
-27
lines changed

2 files changed

+27
-27
lines changed

README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,30 @@
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-
JsonApiClient is a PHP Library to validate and handle the response body from a [JSON API](http://jsonapi.org) Server.
9+
JsonApiClient :construction_worker_woman: 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-
### WIP: Goals for 1.0
13+
## :checkered_flag: Goals
1414

15-
* [x] Be 100% JSON API 1.0 spec conform
16-
* [x] Handle/validate a server response body
17-
* [x] Offer an easy way to retrieve the data
18-
* [x] Be extendable and allow injection of classes/models
19-
* [x] Handle/validate a client request body
20-
* [ ] Refactore and remove the deprecated code
15+
* :heavy_check_mark: Be 100% JSON API spec conform
16+
* :heavy_check_mark: Be open for new spec versions
17+
* :heavy_check_mark: Handle/validate a server response body
18+
* :heavy_check_mark: Handle/validate a client request body
19+
* :heavy_check_mark: Offer an easy way to retrieve the data
20+
* :heavy_check_mark: Allow extendability and injection of classes/models
2121

22-
### Upgrade notice
22+
## :package: Install
2323

24-
JsonApiClient can be considered as stable and version 0.10 will be the last development version.
24+
Via Composer
25+
26+
``` bash
27+
$ composer require art4/json-api-client
28+
```
29+
30+
### :building_construction: Development notice
31+
32+
**JsonApiClient can be considered as stable** and version 0.10 will be the last development version.
2533

2634
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.
2735

@@ -35,21 +43,13 @@ This simply means for you:
3543

3644
(Compare the [Symfony upgrade documentation](https://symfony.com/doc/current/setup/upgrade_major.html))
3745

38-
#### Attention for older versions
46+
#### :warning: Attention for older versions
3947

4048
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.
4149

42-
## Install
43-
44-
Via Composer
45-
46-
``` bash
47-
$ composer require art4/json-api-client
48-
```
49-
50-
## Usage
50+
## :rocket: Usage
5151

52-
See the [documentation](docs/README.md).
52+
See the [quickstart guide](docs/helper-parser.md) or the [documentation](docs/README.md).
5353

5454
### Using as parser
5555

@@ -116,25 +116,25 @@ if ( Parser::isValidResponseString($wrong_jsonapi) ) {
116116

117117
Need more functionality? Want to directly inject your model? Easily extend JsonApiClient with the [Factory](docs/utils-factory.md).
118118

119-
## Changelog
119+
## :loud_sound: Changelog
120120

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

123-
## Testing
123+
## :white_check_mark: Testing
124124

125125
``` bash
126126
$ phpunit
127127
```
128128

129-
## Contributing
129+
## :wrench: Contributing
130130

131131
Please feel free to fork and sending Pull Requests. This project follows [Semantic Versioning 2](http://semver.org) and [PSR-2](http://www.php-fig.org/psr/psr-2/).
132132

133-
## Credits
133+
## :heart: Credits
134134

135135
- [Artur Weigandt](https://github.com/Art4) [![Twitter](http://img.shields.io/badge/Twitter-@weigandtlabs-blue.svg)](https://twitter.com/weigandtlabs)
136136
- [All Contributors](../../contributors)
137137

138-
## License
138+
## :page_facing_up: License
139139

140140
GPL3. Please see [License File](LICENSE) for more information.

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Navigation
22

3-
### :rocket:Quickstart
3+
### :rocket: Quickstart
44

55
Take a look at the [Parser](helper-parser.md) to quickstart with JsonApiClient.
66

0 commit comments

Comments
 (0)