Merge pull request #316 from lptn/refresh-readme

Refresh readme

README.md

@@ -7,45 +7,59 @@
 [![Tests](https://github.com/psalm/psalm-plugin-laravel/actions/workflows/test-laravel.yml/badge.svg)](https://github.com/psalm/psalm-plugin-laravel/actions/workflows/test-laravel.yml)
 
 ## Overview
-This package brings static analysis and type support to projects using Laravel. Our goal is to find as many type-related
+This [Psalm](https://github.com/vimeo/psalm) plugin brings static analysis and type support to projects using Laravel. Our goal is to find as many type-related
  bugs as possible, therefore increasing developer productivity and application health. Find bugs without the overhead
  of writing tests!
 
  ![Screenshot](/assets/screenshot.png)
 
+
 ## Versions & Dependencies
 
-| Laravel Psalm Plugin | PHP   | Laravel    | Psalm |
-|----------------------|-------|------------|-------|
-| 3.x                  | ^8.0  | 9, 10      | 5     |
-| 2.x                  | ^8.0  | 8, 9       | 4, 5  |
-| 1.x                  | ^7.1  | 5, 6, 7, 8 | 3, 4  |
+| Laravel Psalm Plugin | PHP   | Laravel     | Psalm |
+|----------------------|-------|-------------|-------|
+| 2.x                  | ^8.0  | 8, 9, 10    | 4, 5  |
+| 1.x                  | ^7.1  | 5, 6, 7, 8  | 3, 4  |
+
+See [releases](https://github.com/psalm/psalm-plugin-laravel/releases) for more details about supported PHP, Laravel and Psalm versions.
 
 
 ## Quickstart
-Please refer to the [full Psalm documentation](https://psalm.dev/quickstart) for a more detailed guide on introducing Psalm
-into your project.
 
-First, start by installing Psalm if you have not done so already:
-```bash
-composer require --dev vimeo/psalm
-./vendor/bin/psalm --init
-```
+### Step 1: Install
 
-Next, install this package and enable the plugin
 ```bash
 composer require --dev psalm/plugin-laravel
 ./vendor/bin/psalm-plugin enable psalm/plugin-laravel
 ```
 
-Finally, run Psalm to analyze your codebase
+### Step 2: Configure
+If you didn't use Psalm on the project before, you need to create a Psalm config:
+```bash
+./vendor/bin/psalm --init
+```
+
+### Step 3: Run 🚀
+Run your usual Psalm command:
 ```bash
 ./vendor/bin/psalm
 ```
 
+You can customize Psalm configuration using [XML config](https://psalm.dev/docs/running_psalm/configuration/)
+and/or [cli parameters](https://psalm.dev/docs/running_psalm/command_line_usage/).
+
+**Recommendation**: use [baseline file](https://psalm.dev/docs/running_psalm/dealing_with_code_issues/#using-a-baseline-file) and increase
+`errorLevel` at least to `4`: this way you can catch more issues. Step by step set `errorLevel` to `1` and use Psalm and this plugin at full power 🚀.  
+
+
 ## How it works
 
 Under the hood it just runs https://github.com/barryvdh/laravel-ide-helper and feeds the resultant stubs into Psalm, which can read PhpStorm meta stubs.
 
 It also parses any database migrations it can find to try to understand property types in your database models.
 
+
+## Psalm-Laravel-Plugin or Larastan?
+
+Both! It's fine to use both tools at the same project: they use different approaches to analyze code, and thus you can find more bugs!
+Psalm and PHPStan use almost same the syntax annotations, so you should not have any conflicts.