From 48c42c65ea72014cbddad39e2901711e73dd9aa5 Mon Sep 17 00:00:00 2001
From: Perreal Guillaume <guillaume.perreal@irstea.fr>
Date: Tue, 19 Mar 2019 17:00:28 +0100
Subject: [PATCH] Added a README.md file.

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ba5446d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# irstea/phpstan-config
+
+Configuration pour phpstan/phpstan.
+
+Inclut les extensions PHPStan pour les outils suivant :
+
+- Doctrine
+- Symfony
+- PHPUnit
+- [beberlei/assert](https://github.com/beberlei/assert)
+- [phpspec/prophecy](https://github.com/phpspec/prophecy)
+
+### Installation
+
+```shell
+composer require --dev irstea/phpstan-config
+```
+
+### Configuration
+
+Exemple :
+
+```neon
+includes:
+    - vendor/irstea/phpstan-config/phpstan.neon
+
+parameters:
+    paths:
+        - src
+        - tests
+
+    symfony:
+        container_xml_path: %currentWorkingDirectory%/var/cache/test/srcApp_KernelTestDebugContainer.xml
+
+```
+
+cf. https://github.com/phpstan/phpstan#configuration pour plus de détails.
+
+### Usage
+
+```shell
+vendor/bin/phpstan analyse
+```
-- 
GitLab