Update readme

readme.md

@@ -1,12 +1,16 @@
 ## Laravel 5 IDE Helper Generator
 [![Latest Stable Version](https://poser.pugx.org/barryvdh/laravel-ide-helper/version.png)](https://packagist.org/packages/barryvdh/laravel-ide-helper) [![Total Downloads](https://poser.pugx.org/barryvdh/laravel-ide-helper/d/total.png)](https://packagist.org/packages/barryvdh/laravel-ide-helper)
 
-### For Laravel 4.x, check [version 1.11](https://github.com/barryvdh/laravel-ide-helper/tree/1.11)
+__For Laravel 4.x, check [version 1.11](https://github.com/barryvdh/laravel-ide-helper/tree/1.11)__
 
 ### Complete phpDocs, directly from the source
 
 _Checkout [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
 
+ * [`php artisan ide-helper:generate` - phpDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades)
+ * [`php artisan ide-helper:models` - phpDocs for models](#automatic-phpdocs-for-models)
+ * [`php artisan ide-helper:meta` - PhpStorm Meta file](#phpstorm-meta-for-container-instances)
+
 This package generates a file that your IDE understands, so it can provide accurate autocompletion. Generation is done based on the files in your project, so they are always up-to-date.
 If you don't want to generate it, you can add a pre-generated file to the root folder of your Laravel project (but this isn't as up-to-date as self generated files).
 
@@ -16,55 +20,48 @@ If you don't want to generate it, you can add a pre-generated file to the root f
 
 Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel
 
-### New: PhpStorm Meta for Container instances
-
-It's possible to generate a PhpStorm meta file, to [add support for factory design pattern](https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata). For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container. For example, `events` will return an `Illuminate\Events\Dispatcher` object, so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods.
-
-    php artisan ide-helper:meta
-
-    app('events')->fire();
-    \App::make('events')->fire();
-
-    /** @var \Illuminate\Foundation\Application $app */
-    $app->make('events')->fire();
-    
-    // When the key is not found, it uses the argument as class name
-    app('App\SomeClass');
-
-Pre-generated example: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
-
-> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
-> Note: When you receive a FatalException about a class that is not found, check your config (for example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it).
-
-### Automatic phpDoc generation for Laravel Facades
+### Install
 
 Require this package with composer using the following command:
 
-    composer require barryvdh/laravel-ide-helper
+```bash
+composer require barryvdh/laravel-ide-helper
+```
 
 After updating composer, add the service provider to the `providers` array in `config/app.php`
 
-    Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
+```php
+Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
+```
+
+### Automatic phpDoc generation for Laravel Facades
+
 
 You can now re-generate the docs yourself (for future updates)
 
-    php artisan ide-helper:generate
+```bash
+php artisan ide-helper:generate
+```
 
 Note: `bootstrap/compiled.php` has to be cleared first, so run `php artisan clear-compiled` before generating (and `php artisan optimize` after).
 
 You can configure your composer.json to do this after each commit:
 
-    "scripts":{
-        "post-update-cmd": [
-            "php artisan clear-compiled",
-            "php artisan ide-helper:generate",
-            "php artisan optimize"
-        ]
-    },
+```js
+"scripts":{
+    "post-update-cmd": [
+        "php artisan clear-compiled",
+        "php artisan ide-helper:generate",
+        "php artisan optimize"
+    ]
+},
+```
 
 You can also publish the config file to change implementations (ie. interface to specific class) or set defaults for `--helpers` or `--sublime`.
 
-    php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config
+```bash
+php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config
+```
 
 The generator tries to identify the real class, but if it cannot be found, you can define it in the config file.
 
@@ -84,37 +81,71 @@ Please make sure to backup your models, before writing the info.
 It should keep the existing comments and only append new properties/methods. The existing phpdoc is replaced, or added if not found.
 With the `--reset (-R)` option, the existing phpdocs are ignored, and only the newly found columns/relations are saved as phpdocs.
 
-    php artisan ide-helper:models Post
+```bash
+php artisan ide-helper:models Post
+```
 
-    /**
-     * An Eloquent Model: 'Post'
-     *
-     * @property integer $id
-     * @property integer $author_id
-     * @property string $title
-     * @property string $text
-     * @property \Carbon\Carbon $created_at
-     * @property \Carbon\Carbon $updated_at
-     * @property-read \User $author
-     * @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
-     */
+```php
+/**
+ * An Eloquent Model: 'Post'
+ *
+ * @property integer $id
+ * @property integer $author_id
+ * @property string $title
+ * @property string $text
+ * @property \Carbon\Carbon $created_at
+ * @property \Carbon\Carbon $updated_at
+ * @property-read \User $author
+ * @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
+ */
+```
 
 By default, models in `app/models` are scanned. The optional argument tells what models to use (also outside app/models).
 
-    php artisan ide-helper:models Post User
+```bash
+php artisan ide-helper:models Post User
+```
 
 You can also scan a different directory, using the `--dir` option (relative from the base path):
 
-    php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
+```bash
+php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
+```
 
 You can publish the config file (`php artisan vendor:publish`) and set the default directories.
 
 Models can be ignored using the `--ignore (-I)` option
 
-    php artisan ide-helper:models --ignore="Post,User"
+```bash
+php artisan ide-helper:models --ignore="Post,User"
+```
 
 Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
 
+## PhpStorm Meta for Container instances
+
+It's possible to generate a PhpStorm meta file, to [add support for factory design pattern](https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata). For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container. For example, `events` will return an `Illuminate\Events\Dispatcher` object, so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods.
+
+``` bash
+php artisan ide-helper:meta
+```
+
+```php
+app('events')->fire();
+\App::make('events')->fire();
+
+/** @var \Illuminate\Foundation\Application $app */
+$app->make('events')->fire();
+
+// When the key is not found, it uses the argument as class name
+app('App\SomeClass');
+```
+
+Pre-generated example: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
+
+> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
+> Note: When you receive a FatalException about a class that is not found, check your config (for example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it).
+
 ### License
 
 The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)