Added documentation for the @xml change

h3rj4n · h3rj4n · commit a1fa4aa83b95 · 2015-10-28T10:36:06.000+01:00
diff --git a/LSS/Array2XML.php b/LSS/Array2XML.php
@@ -49,6 +49,8 @@
  *          - Reverted to version 0.5
  * Version: 0.8 (02 May 2012)
  *          - Removed htmlspecialchars() before adding to text node or attributes.
+ * Version: 0.11 (28 October 2015)
+ *          - Fixed typos; Added support for plain insertion of XML trough @xml.
  *
  * Usage:
  *       $xml = Array2XML::createXML('root_node_name', $php_array);
diff --git a/README.md b/README.md
@@ -15,6 +15,38 @@ $array = XML2Array::createArray($xml);
 print_r($array);
 ```
 
+Array2XML
+----
+
+@xml example:
+```php
+// Build the array that should be transformed into a XML object.
+$array = [
+    'title' => 'A title',
+    'body' => [
+        '@xml' => '<html><body><p>The content for the news item</p></body></html>',
+    ],
+];
+
+// Use the Array2XML object to transform it.
+$xml = Array2XML::createXML('news', $array);
+echo $xml->saveXML();
+```
+This will result in the following.
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<news>
+  <title>A title</title>
+  <body>
+    <html>
+      <body>
+        <p>The content for the news item</p>
+      </body>
+    </html>
+  </body>
+</news>
+```
+
 Reference
 ----
 More complete references can be found here

Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,8 @@`
`49`	`49`	`* - Reverted to version 0.5`
`50`	`50`	`* Version: 0.8 (02 May 2012)`
`51`	`51`	`* - Removed htmlspecialchars() before adding to text node or attributes.`
	`52`	`+ * Version: 0.11 (28 October 2015)`
	`53`	`+ * - Fixed typos; Added support for plain insertion of XML trough @xml.`
`52`	`54`	`*`
`53`	`55`	`* Usage:`
`54`	`56`	`* $xml = Array2XML::createXML('root_node_name', $php_array);`