-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of github.com:nilportugues/api-transformer
- Loading branch information
Showing
5 changed files
with
88 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,9 +2,7 @@ | |
|
||
[![Build Status] | ||
(https://travis-ci.org/nilportugues/api-transformer.svg)] | ||
(https://travis-ci.org/nilportugues/api-transformer) [![Coverage Status] | ||
(https://coveralls.io/repos/nilportugues/api-transformer/badge.svg?branch=master&service=github)] | ||
(https://coveralls.io/github/nilportugues/api-transformer?branch=master) [![Scrutinizer Code Quality] | ||
(https://travis-ci.org/nilportugues/api-transformer) [![Coverage Status](https://coveralls.io/repos/nilportugues/api-transformer/badge.svg?branch=master&service=github)](https://coveralls.io/github/nilportugues/api-transformer?branch=master) [![Scrutinizer Code Quality] | ||
(https://scrutinizer-ci.com/g/nilportugues/api-transformer/badges/quality-score.png?b=master)] | ||
(https://scrutinizer-ci.com/g/nilportugues/api-transformer/?branch=master) [![SensioLabsInsight] | ||
(https://insight.sensiolabs.com/projects/b4e5056d-c552-407e-ae21-2da685e07c06/mini.png)] | ||
|
@@ -15,3 +13,72 @@ | |
(https://packagist.org/packages/nilportugues/api-transformer) [![License] | ||
(https://poser.pugx.org/nilportugues/api-transformer/license)] | ||
(https://packagist.org/packages/nilportugues/api-transformer) | ||
|
||
## Purpose | ||
This library provides the core functionality for API transformation. As a base library, by itself it's not usable at all. | ||
|
||
## Used by | ||
|
||
Currently the following transformers make use of this library as foundation: | ||
|
||
- [nilportugues/json](https://github.com/nilportugues/json-transformer) | ||
- [nilportugues/jsend](https://github.com/nilportugues/jsend-transformer) | ||
- [nilportugues/haljson](https://github.com/nilportugues/hal-json-transformer) | ||
- [nilportugues/json-api](https://github.com/nilportugues/jsonapi-transformer) | ||
|
||
|
||
## Quality | ||
|
||
To run the PHPUnit tests at the command line, go to the tests directory and issue phpunit. | ||
|
||
This library attempts to comply with [PSR-1](http://www.php-fig.org/psr/psr-1/), [PSR-2](http://www.php-fig.org/psr/psr-2/), [PSR-4](http://www.php-fig.org/psr/psr-4/) and [PSR-7](http://www.php-fig.org/psr/psr-7/). | ||
|
||
If you notice compliance oversights, please send a patch via pull request. | ||
|
||
|
||
## Installation | ||
|
||
Use [Composer](https://getcomposer.org) to install the package: | ||
|
||
```json | ||
$ composer require nilportugues/api-transformer | ||
``` | ||
|
||
|
||
## Quality | ||
|
||
To run the PHPUnit tests at the command line, go to the tests directory and issue phpunit. | ||
|
||
This library attempts to comply with [PSR-1](http://www.php-fig.org/psr/psr-1/), [PSR-2](http://www.php-fig.org/psr/psr-2/), [PSR-4](http://www.php-fig.org/psr/psr-4/) and [PSR-7](http://www.php-fig.org/psr/psr-7/). | ||
|
||
If you notice compliance oversights, please send a patch via [Pull Request](https://github.com/nilportugues/api-transformer/pulls). | ||
|
||
|
||
|
||
## Contribute | ||
|
||
Contributions to the package are always welcome! | ||
|
||
* Report any bugs or issues you find on the [issue tracker](https://github.com/nilportugues/api-transformer/issues/new). | ||
* You can grab the source code at the package's [Git repository](https://github.com/nilportugues/api-transformer). | ||
|
||
|
||
|
||
## Support | ||
|
||
Get in touch with me using one of the following means: | ||
|
||
- Emailing me at <[email protected]> | ||
- Opening an [Issue](https://github.com/nilportugues/api-transformer/issues/new) | ||
- Using Gitter: [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/nilportugues/api-transformer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) | ||
|
||
|
||
|
||
## Authors | ||
|
||
* [Nil Portugués Calderó](http://nilportugues.com) | ||
* [The Community Contributors](https://github.com/nilportugues/api-transformer/graphs/contributors) | ||
|
||
|
||
## License | ||
The code base is licensed under the [MIT license](LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters