update README.md

README.md

@@ -1,44 +1,39 @@
 DigiComp.SettingValidator
 -------------------------
 
-
+This Package allows configuring Validators for your Action-Arguments or domain model properties to be set by a new
-This Package allows to configure Validators for your Action-Arguments or domain model properties to be set by a new
 Yaml-File in your Configuration directory.
 
-Lets imagine you had this action-method:
+Let's imagine you had this action-method:
 
     /**
+     * @Flow\Validate(type="DigiComp.SettingValidator:Settings", argumentName="order")
      * @param Order $order
-     * @Flow\Validate(type="DigiComp.SettingValidator:Settings")
      */
     public function createOrder($order) {...}
 
 Then your Validation.yaml could look like this:
 
-    SuperVendor\SuperPackage\Domain\Model\Order:
+    Vendor\Package\Domain\Model\Order:
-      -
+      # validates the complete object
-        property: price
+      self:
-        validator: NumberRange
+        'Vendor.Package:SomeOtherValidator': []
-        options:
+      # validates properties of the object
-          maximum: 20
+      properties:
-          minimum: 10
+        price:
-      -
+          NumberRange:
-        validator: SuperVendor.SuperPackage:SomeOtherValidator #validates the complete object
+            maximum: 20
-        options: []
+            minimum: 10
-      -
+        customer:
-        property: customer
+          'DigiComp.SettingValidator:Settings':
-        validator: DigiComp.SettingValidator:Settings
+            name: 'OrderCustomer'
-        options:
-          name: OrderCustomer
 
     OrderCustomer:
-      -
+      properties:
-        property: firstName
+        firstName:
-        validator: StringLength
+          StringLength:
-        options:
+            minimum: 3
-          minimum: 3
+            maximum: 20
-          maximum: 20
-
 
 As you see: Nesting is possible ;) That way you can easily construct flexible structures.