diff --git a/README.md b/README.md index 34568ab..70c9533 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Acme Tools for Symfony +Symfony Bundle Template ==== ![Build Status](https://github.com/headsnet/acme-tools-bundle/actions/workflows/ci.yml/badge.svg) @@ -8,23 +8,18 @@ Acme Tools for Symfony [![License](https://poser.pugx.org/headsnet/acme-tools-bundle/license)](//packagist.org/packages/headsnet/acme-tools-bundle) [![PHP Version Require](http://poser.pugx.org/headsnet/acme-tools-bundle/require/php)](//packagist.org/packages/headsnet/acme-tools-bundle) -## Installation +A template repository for creating Symfony bundles. Comes preconfigured with: -```bash -composer require headsnet/acme-tools-bundle -``` -If your Symfony installation does not auto-register bundles, add it manually: +- [Easy Coding Standard](https://github.com/easy-coding-standard/easy-coding-standard) +- [PHPStan](https://phpstan.org/) +- [PHPUnit](https://docs.phpunit.de/en/10.5/) -```php -// bundles.php -return [ - ... - Headsnet\AcmeToolsBundle\HeadsnetAcmeToolsBundle::class => ['all' => true], -]; -``` -## Contributions +## Usage -Contributions are welcome via Pull Requests. Please include a single change in each PR. +1. Create your own repository based on this template repository +2. Search `AcmeTools` and replace with `YourPackage` +3. Search `acme-tools` and replace with `your-package` +4. Enjoy! ## License