From fbcb7050f77c0aca236fdb58dcf9d2505d743dcd Mon Sep 17 00:00:00 2001
From: ebln <34722048+ebln@users.noreply.github.com>
Date: Fri, 7 Jun 2024 13:21:41 +0200
Subject: [PATCH] Update Readme & Todo list

---
 CHANGELOG.md | 13 +++++++++++++
 README.md    | 45 ++++++++++++++++++++++++++++++++++++++++-----
 2 files changed, 53 insertions(+), 5 deletions(-)

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
+<?php
+// […]
+
+#[\Ebln\Attrib\ForceFactory(GoodFactory::class, BetterFactory::class)]
+class OnlyViaFactory
+{
+}
+```
+
+Now lean back and rely on PHPStan in CI pipelines, git hooks or IDE integrations;
+If somebody introduces a rogue factory:
+```php
+<?php
+// […]
+
+class FailingFactory
+{
+    public function create(): OnlyViaFactory
+    {   
+        return new OnlyViaFactory();
+    }
+}
+```
+…that is supposed to fail, when you run PHPStan.
+
+## Deprecated usage with `ebln/phpstan-factory-mark`
+
+Require this extention and [the package containing the marking interface](https://github.com/ebln/phpstan-factory-mark) via [Composer](https://getcomposer.org/) alongside with PHPStan:
+```shell
+composer require ebln/phpstan-factory-mark
+composer require --dev ebln/phpstan-factory-rule
+```
 
 Implement `\Ebln\PHPStan\EnforceFactory\ForceFactoryInterface` with the DTO you want to protect.
 ```php
@@ -42,10 +77,10 @@ class FailingFactory
 
 ## Installation
 
-Require this extention and [the package containing the interface](https://github.com/ebln/phpstan-factory-mark) via [Composer](https://getcomposer.org/):
+Require this extention via [Composer](https://getcomposer.org/):
 
-```
-composer require ebln/phpstan-factory-mark && composer require --dev ebln/phpstan-factory-rule
+```php
+composer require --dev ebln/phpstan-factory-rule
 ```
 
 If you also install [phpstan/extension-installer](https://github.com/phpstan/extension-installer) then you're all set!