Skip to content

Commit 0cbf123

Browse files
committed
Grammar and spelling fixes in readme
1 parent c38c735 commit 0cbf123

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![Latest Unstable Version](https://poser.pugx.org/stecman/symfony-console-completion/v/unstable.svg)](https://packagist.org/packages/stecman/symfony-console-completion)
99
[![License](https://poser.pugx.org/stecman/symfony-console-completion/license.svg)](https://packagist.org/packages/stecman/symfony-console-completion)
1010

11-
This package provides automatic (tab) completion in BASH and ZSH for Symfony Console Component based applications. With zero configuration, this package allows completion of available command names and the options they provide. User code can define custom completion behaviour for arugment and option values.
11+
This package provides automatic (tab) completion in BASH and ZSH for Symfony Console Component based applications. With zero configuration, this package allows completion of available command names and the options they provide. User code can define custom completion behaviour for argument and option values.
1212

1313
Example of zero-config use with Composer:
1414

@@ -33,10 +33,10 @@ If you don't need any custom completion behaviour, you can simply add the comple
3333
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'):
3434

3535
```bash
36-
# BASH 4.x, ZSH
36+
# BASH ~4.x, ZSH
3737
source <([program] _completion --generate-hook)
3838

39-
# BASH 3.x, ZSH
39+
# BASH ~3.x, ZSH
4040
[program] _completion --generate-hook | source /dev/stdin
4141

4242
# BASH (any version)
@@ -52,19 +52,19 @@ Note: The type of shell (ZSH/BASH) is automatically detected using the `SHELL` e
5252

5353
## How it works
5454

55-
The `--generate-hook` option of `CompletionCommand` generates a small shell script that registers a function with your shell's completion system to act as a bridge to the completion command in your application. When you request completion for your program (by pressing tab with your program name as the first word on the command line), the bridge function is run; passing the current command line contents and cursor position to `[program] _completion`, and feeding the resulting output back to the shell.
55+
The `--generate-hook` option of `CompletionCommand` generates a small shell script that registers a function with your shell's completion system to act as a bridge between the shell and the completion command in your application. When you request completion for your program (by pressing tab with your program name as the first word on the command line), the bridge function is run; passing the current command line contents and cursor position to `[program] _completion`, and feeding the resulting output back to the shell.
5656

5757

5858
## Defining value completions
5959

60-
By default, no completion results will be returned for option and argument values. There are two ways of defining custom completion values for values: extend `CompletionCommand`, or implement `CompletionAwareInterface` interface.
60+
By default, no completion results will be returned for option and argument values. There are two ways of defining custom completion values for values: extend `CompletionCommand`, or implement `CompletionAwareInterface`.
6161

6262
### Implementing `CompletionAwareInterface`
6363

6464
`CompletionAwareInterface` allows a command to be responsible for completing its own option and argument values. When completion is run with a command name specified (eg. `myapp mycommand ...`) and the named command implements this interface, the appropriate interface method is called automatically:
6565

6666
```php
67-
class MyCommand extends Command impements CompletionAwareInterface
67+
class MyCommand extends Command implements CompletionAwareInterface
6868
{
6969
...
7070

@@ -219,7 +219,7 @@ new Completion(
219219

220220
### Completing filesystem paths
221221

222-
This library provides the completion implementation `ShellPathCompletion` which defers path completion to the shell's built-in path completion behaviour rather than implementing it in PHP.
222+
This library provides the completion implementation `ShellPathCompletion` which defers path completion to the shell's built-in path completion behaviour rather than implementing it in PHP, so that users get the path completion behaviour they expect from their shell.
223223

224224
```php
225225
new Completion\ShellPathCompletion(

0 commit comments

Comments
 (0)