Skip to content

Commit

Permalink
Update readme text with usage instructions (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
benr77 authored Jun 25, 2024
1 parent bd288c8 commit 12e48eb
Showing 1 changed file with 10 additions and 15 deletions.
25 changes: 10 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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

Expand Down

0 comments on commit 12e48eb

Please sign in to comment.