Skip to content

Commit

Permalink
Update README to Symfony Flex-compatible installation and configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
mhujer committed Mar 7, 2020
1 parent 052abad commit 9887719
Showing 1 changed file with 14 additions and 17 deletions.
31 changes: 14 additions & 17 deletions README.md
Expand Up @@ -11,24 +11,21 @@ Installation

If you're using Symfony Flex, the following steps will be done automatically.

2. Add this bundle to your application's kernel:

``` php
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
// ...
new WhiteOctober\BreadcrumbsBundle\WhiteOctoberBreadcrumbsBundle(),
// ...
);
}
```
2. Enable the bundle by adding it to the list of registered bundles in the `config/bundles.php` file of your project:

```php
// config/bundles.php

return [
// ...
WhiteOctober\BreadcrumbsBundle\WhiteOctoberBreadcrumbsBundle::class => ['all' => true],
];
```

3. Configure the bundle in your config:
3. Configure the bundle in `config/packages/white_october_breadcrumbs.yaml`:

``` yaml
# app/config/config.yml
# config/packages/white_october_breadcrumbs.yaml
white_october_breadcrumbs: ~
```

Expand Down Expand Up @@ -126,10 +123,10 @@ public function yourAction()
Configuration
=============

The following *default* parameters can be overriden in your `config.yml` or similar:
The following *default* parameters can be overridden in your `config/packages/white_october_breadcrumbs.yaml`:

``` yaml
# app/config/config.yml
# config/packages/white_october_breadcrumbs.yaml
white_october_breadcrumbs:
separator: '/'
separatorClass: 'separator'
Expand Down

0 comments on commit 9887719

Please sign in to comment.