create the version 1.0.0

spieljs · Jun 1, 2018 · c15e5e2 · c15e5e2
1 parent 026f341
commit c15e5e2
Show file tree

Hide file tree

Showing 13 changed files with 50 additions and 40 deletions.
diff --git a/README.md b/README.md
@@ -203,6 +203,10 @@ describe("Component", () => {
 });
 ```
 
+# Example
+
+[Simple Spiel Ultradom Example](https://github.com/spiel-examples/simple-spiel-ultradom-example)
+
 ## Run Spiel Ultradom test
 
 `yarn test` or `npm test`

diff --git a/READMEAPI.md b/READMEAPI.md
@@ -199,10 +199,14 @@ describe("Component", () => {
 });
 ```
 
+# Example
+
+[Simple Spiel Ultradom Example](https://github.com/spiel-examples/simple-spiel-ultradom-example)
+
 ## Run Spiel Ultradom test
 
 `yarn test` or `npm test`
 
 ## License
 
-Spiel Ultradom is MIT licensed. See [license](README.md)
+Spiel Ultradom is MIT licensed. See [license](https://github.com/spiel-examples/simple-spiel-ultradom-example/blob/master/README.md)
diff --git a/docs/classes/_builder_.ultrabuilder.html b/docs/classes/_builder_.ultrabuilder.html
@@ -121,7 +121,7 @@ <h3>build</h3>
 					<div class="tsd-signature tsd-kind-icon">build<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TBuild</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/builder.ts#L12">builder.ts:12</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/builder.ts#L12">builder.ts:12</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -131,7 +131,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> config<wbr>Router</h3>
 					<div class="tsd-signature tsd-kind-icon">config<wbr>Router<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_interfaces_.iconfigrouter.html" class="tsd-signature-type">IConfigRouter</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/builder.ts#L14">builder.ts:14</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/builder.ts#L14">builder.ts:14</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -141,7 +141,7 @@ <h3>router</h3>
 					<div class="tsd-signature tsd-kind-icon">router<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Navigo</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/builder.ts#L13">builder.ts:13</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/builder.ts#L13">builder.ts:13</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -158,7 +158,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> check<wbr>Default</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/builder.ts#L135">builder.ts:135</a></li>
+									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/builder.ts#L135">builder.ts:135</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -175,7 +175,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> check<wbr>Not<wbr>Found
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/builder.ts#L143">builder.ts:143</a></li>
+									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/builder.ts#L143">builder.ts:143</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -192,7 +192,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> check<wbr>Query</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/builder.ts#L92">builder.ts:92</a></li>
+									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/builder.ts#L92">builder.ts:92</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -215,7 +215,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> check<wbr>State</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/builder.ts#L100">builder.ts:100</a></li>
+									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/builder.ts#L100">builder.ts:100</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -241,7 +241,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> create<wbr>Root<wbr>Ele
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/builder.ts#L73">builder.ts:73</a></li>
+									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/builder.ts#L73">builder.ts:73</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -264,7 +264,7 @@ <h3>go</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/builder.ts#L51">builder.ts:51</a></li>
+									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/builder.ts#L51">builder.ts:51</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -307,7 +307,7 @@ <h3>resolve</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/builder.ts#L66">builder.ts:66</a></li>
+									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/builder.ts#L66">builder.ts:66</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -339,7 +339,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> set<wbr>Render</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/builder.ts#L114">builder.ts:114</a></li>
+									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/builder.ts#L114">builder.ts:114</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -374,7 +374,7 @@ <h3>set<wbr>Router</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/builder.ts#L20">builder.ts:20</a></li>
+									<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/builder.ts#L20">builder.ts:20</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/index.html b/docs/index.html
@@ -238,10 +238,12 @@ <h2 id="how-use-it">How use it</h2>
     });
 });
 </code></pre>
+				<h1 id="example">Example</h1>
+				<p><a href="https://github.com/spiel-examples/simple-spiel-ultradom-example">Simple Spiel Ultradom Example</a></p>
 				<h2 id="run-spiel-ultradom-test">Run Spiel Ultradom test</h2>
 				<p><code>yarn test</code> or <code>npm test</code></p>
 				<h2 id="license">License</h2>
-				<p>Spiel Ultradom is MIT licensed. See <a href="README.md">license</a></p>
+				<p>Spiel Ultradom is MIT licensed. See <a href="https://github.com/spiel-examples/simple-spiel-ultradom-example/blob/master/README.md">license</a></p>
 			</div>
 		</div>
 		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">

diff --git a/docs/interfaces/_interfaces_.iconfigrouter.html b/docs/interfaces/_interfaces_.iconfigrouter.html
@@ -108,7 +108,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> default</h3>
 					<div class="tsd-signature tsd-kind-icon">default<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L43">interfaces.ts:43</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L43">interfaces.ts:43</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -123,7 +123,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> default<wbr>Props</h3
 					<div class="tsd-signature tsd-kind-icon">default<wbr>Props<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L65">interfaces.ts:65</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L65">interfaces.ts:65</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -138,7 +138,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> generic<wbr>Hooks</h3
 					<div class="tsd-signature tsd-kind-icon">generic<wbr>Hooks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IGenericHooks</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L57">interfaces.ts:57</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L57">interfaces.ts:57</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -158,7 +158,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> hash</h3>
 					<div class="tsd-signature tsd-kind-icon">hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L63">interfaces.ts:63</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L63">interfaces.ts:63</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -178,7 +178,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> not<wbr>Found</h3>
 					<div class="tsd-signature tsd-kind-icon">not<wbr>Found<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L47">interfaces.ts:47</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L47">interfaces.ts:47</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -198,7 +198,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> not<wbr>Found<wbr>Hoo
 					<div class="tsd-signature tsd-kind-icon">not<wbr>Found<wbr>Hooks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IHooks</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L59">interfaces.ts:59</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L59">interfaces.ts:59</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -213,7 +213,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> not<wbr>Found<wbr>Pat
 					<div class="tsd-signature tsd-kind-icon">not<wbr>Found<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L49">interfaces.ts:49</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L49">interfaces.ts:49</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -228,7 +228,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> root</h3>
 					<div class="tsd-signature tsd-kind-icon">root<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L75">interfaces.ts:75</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L75">interfaces.ts:75</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -251,7 +251,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> root<wbr>Path</h3>
 					<div class="tsd-signature tsd-kind-icon">root<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L41">interfaces.ts:41</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L41">interfaces.ts:41</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -268,7 +268,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> routes</h3>
 					<div class="tsd-signature tsd-kind-icon">routes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L69">interfaces.ts:69</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L69">interfaces.ts:69</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -288,7 +288,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr>Hash</h3>
 					<div class="tsd-signature tsd-kind-icon">use<wbr>Hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L53">interfaces.ts:53</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L53">interfaces.ts:53</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

diff --git a/docs/interfaces/_interfaces_.ifeatures.html b/docs/interfaces/_interfaces_.ifeatures.html
@@ -100,7 +100,7 @@ <h3>check<wbr>Query</h3>
 					<div class="tsd-signature tsd-kind-icon">check<wbr>Query<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L80">interfaces.ts:80</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L80">interfaces.ts:80</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-type-declaration">
@@ -131,7 +131,7 @@ <h3>check<wbr>State</h3>
 					<div class="tsd-signature tsd-kind-icon">check<wbr>State<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L81">interfaces.ts:81</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L81">interfaces.ts:81</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-type-declaration">
@@ -165,7 +165,7 @@ <h3>default<wbr>Props</h3>
 					<div class="tsd-signature tsd-kind-icon">default<wbr>Props<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L79">interfaces.ts:79</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L79">interfaces.ts:79</a></li>
 						</ul>
 					</aside>
 				</section>

diff --git a/docs/interfaces/_interfaces_.ipage.html b/docs/interfaces/_interfaces_.ipage.html
@@ -106,7 +106,7 @@ <h3>state</h3>
 					<div class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">:</span> <a href="_interfaces_.istate.html" class="tsd-signature-type">IState</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L17">interfaces.ts:17</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L17">interfaces.ts:17</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -116,7 +116,7 @@ <h3>view</h3>
 					<div class="tsd-signature tsd-kind-icon">view<span class="tsd-signature-symbol">:</span> <a href="../modules/_interfaces_.html#tview" class="tsd-signature-type">TView</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L18">interfaces.ts:18</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L18">interfaces.ts:18</a></li>
 						</ul>
 					</aside>
 				</section>

diff --git a/docs/interfaces/_interfaces_.iultraroutes.html b/docs/interfaces/_interfaces_.iultraroutes.html
@@ -129,7 +129,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> default<wbr>Props</h3
 					<div class="tsd-signature tsd-kind-icon">default<wbr>Props<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L25">interfaces.ts:25</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L25">interfaces.ts:25</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -165,7 +165,7 @@ <h3>page</h3>
 					<div class="tsd-signature tsd-kind-icon">page<span class="tsd-signature-symbol">:</span> <a href="_interfaces_.ipage.html" class="tsd-signature-type">IPage</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L29">interfaces.ts:29</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L29">interfaces.ts:29</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -202,7 +202,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> routes</h3>
 					<aside class="tsd-sources">
 						<p>Overrides IRoutes.routes</p>
 						<ul>
-							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/0a24e70/src/interfaces.ts#L33">interfaces.ts:33</a></li>
+							<li>Defined in <a href="https://github.com/spieljs/spiel-ultradom/blob/026f341/src/interfaces.ts#L33">interfaces.ts:33</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">