diff --git a/CHANGELOG.md b/CHANGELOG.md index 27f7217..fd9787c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,19 @@ Intended to follow [«Keep a Changelog»](https://keepachangelog.com/en/) ---- +## Upcomming + +- Remove support for the interface +- Deprecate (abandon) the interface package +- create conflict with interface for version 2 + ```json + { + "conflict": { + "ebln/ebln/phpstan-factory-mark": "*" + } + } + ``` + ---- ## [1.0.0] diff --git a/README.md b/README.md index 78a5b06..6034745 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,44 @@ ebln/phpstan-factory-rule Enforce that your classes get only instantiated by the factories you define! -## Usage +## Usage with support for attributes +Require this package: `composer require --dev ebln/phpstan-factory-rule` -Install this package and the marking package alongside with PHPStan. +Add the `ForceFactory` attribute to your class, and supply all class names as arguments, +which shall be allowed to instanciate your object. +```php +