Update doc

Soyhuce · Aug 5, 2020 · a14635d · a14635d
1 parent 064cdd1
commit a14635d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to `soyhuce/next-ide-helper` will be documented in this file
 
 ## [Next release] - YYYY-MM-DD
 
+### Added
+
+- command `next-ide-helper:aliases` to generate a file helping the ide to understand aliases  
+
 ### Changed
 
 - HasOne relations are documented with `has` in factories docblocks

diff --git a/README.md b/README.md
@@ -23,6 +23,7 @@ All notable changes are described in the [changelog](CHANGELOG.md).
     - [Macros](#macros)
     - [Phpstorm meta](#phpstorm-meta)
     - [Factories](#factories)
+    - [Aliases](#aliases)
     - [Custom application bootstrap](#custom-application-bootstrap)
  - [Contributing](#contributing)
  - [License](#license)    
@@ -364,6 +365,14 @@ class UserFactory extends Factory
     //    
 }
 ```
+
+## Aliases
+
+Sometimes we don't want to use fully qualified class names but prefer to use Laravel aliases.
+
+The command `php artisan next-ide-helper:aliases` will create a file which can be understood by your ide. 
+
+It will then provide auto-completion, syntax hightlight, ... for the aliases defined in your `config/app.php` file as well as the ones defined by the package you use.
 
 ## Custom application bootstrap