Add readme

ruudk · ruudk · commit 2fac98937acd · 2024-08-26T09:16:12.000+02:00
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+<p align="center">
+    A minimalistic error formatter for PHPStan
+</p>
+
+------
+
+## Installation
+
+```command
+$ composer require ticketswap/phpstan-error-formatter
+```
+
+## Usage
+
+Configure PHPStan to use the `ticketswap` error formatter:
+```neon
+parameters:
+    errorFormat: ticketswap
+```
diff --git a/composer.json b/composer.json
@@ -1,5 +1,6 @@
 {
     "name": "ticketswap/phpstan-error-formatter",
+    "description": "A minimalistic error formatter for PHPStan",
     "type": "phpstan-extension",
     "require": {
         "phpstan/phpstan": "^1.11",

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "ticketswap/phpstan-error-formatter",`
	`3`	`+ "description": "A minimalistic error formatter for PHPStan",`
`3`	`4`	`"type": "phpstan-extension",`
`4`	`5`	`"require": {`
`5`	`6`	`"phpstan/phpstan": "^1.11",`