Skip to content

Commit aecbe19

Browse files
committed
Update README.md
1 parent 3367f52 commit aecbe19

File tree

1 file changed

+42
-5
lines changed

1 file changed

+42
-5
lines changed

README.md

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,49 @@ This library attempts to comply with [PSR-1](http://www.php-fig.org/psr/psr-1/),
3636
If you notice compliance oversights, please send a patch via pull request.
3737

3838

39-
## Author
39+
## Installation
4040

41-
Nil Portugués Calderó
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 <contact@nilportugues.com>
72+
- Opening an [Issue](https://github.com/nilportugues/api-transformer/issues/new)
73+
- 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)
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)
4281

43-
- <contact@nilportugues.com>
44-
- [http://nilportugues.com](http://nilportugues.com)
4582

4683
## License
47-
The code base is licensed under the MIT license.
84+
The code base is licensed under the [MIT license](LICENSE).

0 commit comments

Comments
 (0)