added some infos on how the plugin works/how to use it

documents the insights from #26 into the README
phpstan · Sep 4, 2020 · 399481e · 399481e
1 parent bfabc6a
commit 399481e
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,14 @@
 
 * [PHPStan](https://phpstan.org/)
 
+This extension emits deprecation warnings on code, which uses properties/functions/methods/classes which are annotated as `@deprecated`.
+
+In case you don't own the code which you want to be considered deprecated, use [PHPStan Stub Files](https://phpstan.org/user-guide/stub-files) to declare deprecations for vendor files like
+```
+/** @deprecated */
+class ThirdPartyClass {}
+```
+
 
 ## Installation