Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
docs: Mention installation process for a Symfony Framework app (#76)
  • Loading branch information
AlexeyKosov committed Jul 11, 2017
1 parent 8b1d65f commit b287259
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Expand Up @@ -23,7 +23,7 @@ If you don't need any custom completion behaviour, you can simply add the comple
$ composer require stecman/symfony-console-completion
```

2. Add an instance of `CompletionCommand` to your application's `Application::getDefaultCommands()` method:
2. For standalone Symfony Console applications, add an instance of `CompletionCommand` to your application's `Application::getDefaultCommands()` method:

```php
protected function getDefaultCommands()
Expand All @@ -33,6 +33,18 @@ If you don't need any custom completion behaviour, you can simply add the comple
//...
}
```

For Symfony Framework applications, register the `CompletionCommand` as a service in `app/config/services.yml`:

```yaml
services:
#...
console.completion_command:
class: Stecman\Component\Symfony\Console\BashCompletion\CompletionCommand
tags:
- { name: console.command }
#...
```

3. Register completion for your application by running one of the following in a terminal, replacing `[program]` with the command you use to run your application (eg. 'composer'):

Expand Down

0 comments on commit b287259

Please sign in to comment.