Add basic documentation

Classes/Domain/Task/Review/ReviewTask.php

@@ -59,8 +59,8 @@ final class ReviewTask implements TaskInterface
      * @param \DateTimeImmutable $scheduledTime
      * @param ActionStatusType $actionStatus
      * @param Agent $agent
-     * @param NodeInterface|null $object
-     * @param UriInterface $target
+     * @param TraversableNodeInterface|null $object
+     * @param UriInterface|null $target
      */
     public function __construct(
         TaskIdentifier $identifier,

Documentation/00_Index.md

@@ -0,0 +1 @@
+1. [Configuration](./Documentation/01_Configuration.md)

Documentation/01_Configuration.md

@@ -0,0 +1,32 @@
+<div align="center">
+    <a href="./00_Index.md">Index</a>
+</div>
+
+---
+
+# 1. Configuration
+
+Bitzer review tasks can be set up completely via configuration. There are two mixin NodeTypes provided
+that can be used by any custom node type that should have review capabilities:
+```yaml
+'Acme.Site:Document.NewsArticle':
+  superTypes:
+    'Sitegeist.Bitzer.Review:Mixin.Reviewable': true
+    'Sitegeist.Bitzer.Review:Mixin.Setting.Review': true
+```
+The `Reviewable` mixin flags the node type as reviewable, while the `Setting.Review` mixin provides the necessary properties:
+
+![Screenshot of Inspector Editor](inspector.png)
+
+Whenever a node of a node type configured as above is published, a review task will be automatically created
+using the selected agent and interval. After the interval has passed, it will appear in Bitzer's
+task overview module for the agent and can be activated there. Activation will set the task to state `active`
+and redirect the user to the node in the Neos backend view. Once the node is reviewed,
+the task can either be manually completed or will be automatically completed when the node is published again,
+triggering the creation of a new review task for the future.
+
+---
+
+<div align="center">
+    <a href="./00_Index.md">Index</a>
+</div>

README.md

@@ -0,0 +1,19 @@
+# Sitegeist.Bitzer.Review
+
+> The review task plugin for the Bitzer content lifecycle task manager for Neos CMS
+
+## Features
+
+This package provides review tasks for Bitzer. They can be configured to be
+automatically created and completed on node publication as well as manually handled
+via Bitzer's management module and command controller.
+
+## Installation
+
+```
+composer require sitegeist/bitzer-review
+```
+
+## Documentation
+
+1. [Configuration](./Documentation/01_Configuration.md)