Skip to content

Commit 5ab7507

Browse files
committed
Update README.md
1 parent 3e9afc4 commit 5ab7507

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,33 @@
1313
(https://packagist.org/packages/nilportugues/api-transformer) [![License]
1414
(https://poser.pugx.org/nilportugues/api-transformer/license)]
1515
(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, PSR-2, and PSR-4. If you notice compliance oversights, please send a patch via pull request.
35+
36+
37+
## Author
38+
39+
Nil Portugués Calderó
40+
41+
- <contact@nilportugues.com>
42+
- [http://nilportugues.com](http://nilportugues.com)
43+
44+
## License
45+
The code base is licensed under the MIT license.

0 commit comments

Comments
 (0)