|
2 | 2 |
|
3 | 3 | [![Build Status]
|
4 | 4 | (https://travis-ci.org/nilportugues/api-transformer.svg)]
|
5 |
| -(https://travis-ci.org/nilportugues/api-transformer) [![Coverage Status] |
6 |
| -(https://coveralls.io/repos/nilportugues/api-transformer/badge.svg?branch=master&service=github)] |
7 |
| -(https://coveralls.io/github/nilportugues/api-transformer?branch=master) [![Scrutinizer Code Quality] |
| 5 | +(https://travis-ci.org/nilportugues/api-transformer) [](https://coveralls.io/github/nilportugues/api-transformer?branch=master) [![Scrutinizer Code Quality] |
8 | 6 | (https://scrutinizer-ci.com/g/nilportugues/api-transformer/badges/quality-score.png?b=master)]
|
9 | 7 | (https://scrutinizer-ci.com/g/nilportugues/api-transformer/?branch=master) [![SensioLabsInsight]
|
10 | 8 | (https://insight.sensiolabs.com/projects/b4e5056d-c552-407e-ae21-2da685e07c06/mini.png)]
|
|
15 | 13 | (https://packagist.org/packages/nilportugues/api-transformer) [![License]
|
16 | 14 | (https://poser.pugx.org/nilportugues/api-transformer/license)]
|
17 | 15 | (https://packagist.org/packages/nilportugues/api-transformer)
|
| 16 | + |
| 17 | +## Purpose |
| 18 | +This library provides the core functionality for API transformation. As a base library, by itself it's not usable at all. |
| 19 | + |
| 20 | +## Used by |
| 21 | + |
| 22 | +Currently the following transformers make use of this library as foundation: |
| 23 | + |
| 24 | +- [nilportugues/json](https://github.com/nilportugues/json-transformer) |
| 25 | +- [nilportugues/jsend](https://github.com/nilportugues/jsend-transformer) |
| 26 | +- [nilportugues/haljson](https://github.com/nilportugues/hal-json-transformer) |
| 27 | +- [nilportugues/json-api](https://github.com/nilportugues/jsonapi-transformer) |
| 28 | + |
| 29 | + |
| 30 | +## Quality |
| 31 | + |
| 32 | +To run the PHPUnit tests at the command line, go to the tests directory and issue phpunit. |
| 33 | + |
| 34 | +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/). |
| 35 | + |
| 36 | +If you notice compliance oversights, please send a patch via pull request. |
| 37 | + |
| 38 | + |
| 39 | +## Installation |
| 40 | + |
| 41 | +Use [Composer](https://getcomposer.org) to install the package: |
| 42 | + |
| 43 | +```json |
| 44 | +$ composer require nilportugues/api-transformer |
| 45 | +``` |
| 46 | + |
| 47 | + |
| 48 | +## Quality |
| 49 | + |
| 50 | +To run the PHPUnit tests at the command line, go to the tests directory and issue phpunit. |
| 51 | + |
| 52 | +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/). |
| 53 | + |
| 54 | +If you notice compliance oversights, please send a patch via [Pull Request](https://github.com/nilportugues/api-transformer/pulls). |
| 55 | + |
| 56 | + |
| 57 | + |
| 58 | +## Contribute |
| 59 | + |
| 60 | +Contributions to the package are always welcome! |
| 61 | + |
| 62 | +* Report any bugs or issues you find on the [issue tracker](https://github.com/nilportugues/api-transformer/issues/new). |
| 63 | +* You can grab the source code at the package's [Git repository](https://github.com/nilportugues/api-transformer). |
| 64 | + |
| 65 | + |
| 66 | + |
| 67 | +## Support |
| 68 | + |
| 69 | +Get in touch with me using one of the following means: |
| 70 | + |
| 71 | + - Emailing me at <[email protected]> |
| 72 | + - Opening an [Issue](https://github.com/nilportugues/api-transformer/issues/new) |
| 73 | + - Using Gitter: [](https://gitter.im/nilportugues/api-transformer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) |
| 74 | + |
| 75 | + |
| 76 | + |
| 77 | +## Authors |
| 78 | + |
| 79 | +* [Nil Portugués Calderó](http://nilportugues.com) |
| 80 | +* [The Community Contributors](https://github.com/nilportugues/api-transformer/graphs/contributors) |
| 81 | + |
| 82 | + |
| 83 | +## License |
| 84 | +The code base is licensed under the [MIT license](LICENSE). |
0 commit comments