Merge pull request #2 from mhor/patch-1

Syntax highlighting on README.md

Author: stecman

README.md

@@ -12,13 +12,13 @@ If you don't need any custom completion behaviour, all you need to do is add the
 
 1. Install `stecman/symfony-console-completion` through composer
 2. Add an instance of `CompletionCommand` to your application's `Application::getDefaultCommands()` method:
-```
-    protected function getDefaultCommands()
-    {
-       ...
-        $commands[] = new \Stecman\Component\Symfony\Console\BashCompletion\CompletionCommand();
-       ...
-    }
+```php
+protected function getDefaultCommands()
+{
+   //...
+    $commands[] = new \Stecman\Component\Symfony\Console\BashCompletion\CompletionCommand();
+   //...
+}
 ```
 
 3. Run `eval $([program] _completion --generate-hook)` in a terminal, replacing `[program]` with the command you use to run your application (eg. 'composer'). By default this registers completion for the absolute path to you application; you can specify a command name to complete for instead using the `-p` option.
@@ -37,89 +37,106 @@ Custom completion behaviour for argument and option values can be added by sub-c
 
 The following examples are for an application with this signature: `myapp (walk|run) [-w|--weather=""] direction`
 
-    class MyCompletionCommand extends CompletionCommand{
-
-        protected function runCompletion()
-        {
-            $this->handler->addHandlers(array(
-
-                // Instances of Completion go here.
-                // See below for examples.
-
-            ));
-
-            return $this->handler->runCompletion();
-        }
+```php
+class MyCompletionCommand extends CompletionCommand {
 
+    protected function runCompletion()
+    {
+        $this->handler->addHandlers(array(
+            // Instances of Completion go here.
+            // See below for examples.
+        ));
+        return $this->handler->runCompletion();
     }
-
+}
+```
 
 **Command-specific argument completion with an array:**
-    
-    $this->handler->addHandler(
-        new Completion(
-            'walk', 'direction', Completion::TYPE_ARGUMENT,
-            array('north', 'east', 'south', 'west')
+  
+```php  
+$this->handler->addHandler(
+    new Completion(
+        'walk',
+        'direction',
+        Completion::TYPE_ARGUMENT,
+        array(
+            'north',
+            'east',
+            'south',
+            'west'
         )
-    );
+    )
+);
+```
 
 This will complete for this:
-
-    myapp walk [tab]
+```bash
+$ myapp walk [tab]
+```
 
 but not this:
-
-    myapp run [tab]
-
+```bash
+$ myapp run [tab]
+```
 
 **Non-command-specific (global) argument completion with a function**
 
-    $this->handler->addHandler(
-        Completion::makeGlobalHandler(
-            'direction', Completion::TYPE_ARGUMENT,
-            function(){
-                $values = array();
-
-                // Fill the array up with stuff
+```php
+$this->handler->addHandler(
+    Completion::makeGlobalHandler(
+        'direction',
+        Completion::TYPE_ARGUMENT,
+        function() {
+            $values = array();
 
-                return $values;
-            }
-        )
-    );
+            // Fill the array up with stuff
+            return $values;
+        }
+    )
+);
+```
 
 This will complete for both commands:
-
-    myapp walk [tab]
-    myapp run [tab]
-
+```bash
+$ myapp walk [tab]
+$ myapp run [tab]
+```
 
 **Option completion**
 
 Option handlers work the same way as argument handlers, except you use `Completion::TYPE_OPTION` for the type..
 
-    $this->handler->addHandler(
-        Completion::makeGlobalHandler(
-            'weather', Completion::TYPE_OPTION,
-            array('raining', 'sunny', 'everything is on fire!')
+```php
+$this->handler->addHandler(
+    Completion::makeGlobalHandler(
+        'weather',
+        Completion::TYPE_OPTION,
+        array(
+            'raining',
+            'sunny',
+            'everything is on fire!'
         )
-    );
-
+    )
+);
+```
 
 ### Example: completing references from a Git repository
 
-    Completion::makeGlobalHandler(
-        'ref',
-        Completion::TYPE_OPTION,
-        function () {
-            $raw = shell_exec('git show-ref --abbr');
-            if (preg_match_all('/refs\/(?:heads|tags)?\/?(.*)/', $raw, $matches)) {
-                return $matches[1];
-            }
+```php
+Completion::makeGlobalHandler(
+    'ref',
+    Completion::TYPE_OPTION,
+    function () {
+        $raw = shell_exec('git show-ref --abbr');
+        if (preg_match_all('/refs\/(?:heads|tags)?\/?(.*)/', $raw, $matches)) {
+            return $matches[1];
         }
-    )
+    }
+)
+```
 
 ## Behaviour notes
 
 * Option shortcuts are not offered as completion options, however requesting completion (ie. pressing tab) on a valid option shortcut will complete.
 * Completion is not implemented for the `--option="value"` style of passing a value to an option, however `--option value` and `--option "value"` work and are functionally identical.
-* There is currently no way to hand-off to BASH to complete folder/file names.
+* There is currently no way to hand-off to BASH to complete folder/file names.