docco

add notes and example data structure

Author: deployable

README.md

@@ -1,6 +1,8 @@
 ## domain-tree
 
-Store domain data in a tree structure
+Store domain data in a tree structure that maintains links to parent and sub domains. 
+
+The intention is sub domains can query data for their parents and use it, if required. 
 
 [![Build status](https://badge.buildkite.com/1745a99401bdd68a6331273b5f95a62d8c2cdae5e6e338c3ef.svg)](https://buildkite.com/deployable/domain-tree-test)
 
@@ -19,4 +21,23 @@ Store domain data in a tree structure
     console.log( tree )
     console.log( tree.toJSON() )
 
+Results in a structure:
+
+    com:
+      domain: 'com'
+      subdomain:
+        whatever:
+          domain: 'whatever.com'
+          subdomain:
+            test:
+              domain: 'test.whatever.com'
+              _data: test: true
+            two:
+              domain: 'two.whatever.com'
+              _data: two: true
+        other:
+          domain: 'other.com'
+          _data: other: true
+
+
 Matt Hoyle - [email protected]