diff --git a/README.md b/README.md index 3d9647d..4fe1357 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,51 @@ -# Auto Git Ignore by Novusvetus -A post-update-cmd script to automatically add Composer managed packages to .gitignore +# Auto Git Ignore by Novusvetus # -## Installation -### Add the following to your composer.json +## Overview ## +A post-update-cmd script to automatically add Composer managed packages to .gitignore. + + +## Installation ## +### Add the following to your composer.json: ### ```json "scripts": { "post-update-cmd": "Novusvetus\\AutoGitIgnore\\GitIgnoreBuilder::go" } ``` -### Add it to your project with: + +### Add it to your project with: ### ```shell composer require novusvetus/autogitignore ``` -### Exclude only dev packages -Add to the following to your composer.json +### Optional - Exclude only dev packages: ### +#### Add to the following to your composer.json #### ```json "extra": { "autogitignore": "devOnly" } ``` -## License +## License ## 3-clause BSD license See [License](LICENSE) -## Bugtracker + +## Bugtracker ## Bugs are tracked in the issues section of this repository on GitHub. Please read over existing issues before submitting an issue to ensure yours is unique. [Create a new issue](../../issues/new) - - Describe the steps to reproduce your issue. - - Describe the expected and the actual outcome. - - Describe your environment as detailed as possible. +- Describe the steps to reproduce your issue. +- Describe the expected and the actual outcome. +- Describe your environment as detailed as possible. + -## Development and contribution +## Development and contribution ## Feature requests can also be made by [creating a new issue](../../issues/new). -If you would like to make contributions to this module, feel free to [create a fork](../../fork) and submit a pull request. +If you would like to make contributions to this repository, feel free to [create a fork](../../fork) and submit a pull request. -## Versioning + +## Versioning ## This project follows [Semantic Versioning](http://semver.org) paradigm. That is: > Given a version number MAJOR.MINOR.PATCH, increment the: @@ -47,5 +54,13 @@ This project follows [Semantic Versioning](http://semver.org) paradigm. That is: > 3. PATCH version when you make backwards-compatible bug fixes. > Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format. -## Thanks to -[mickaelperrin / Mickaël PERRIN](https://github.com/mickaelperrin) + +## Links ## +* [ReindeerWeb](https://www.reindeer-web.de) +* [Novusvetus](https://www.novusvetus.de) +* [License](./LICENSE) +* [Contributing](./CONTRIBUTING.md) + + +## Thanks to ## +* [mickaelperrin / Mickaël PERRIN](https://github.com/mickaelperrin) \ No newline at end of file