From ee7c5e4bad2783a0ccde6a857a8aadd16ad4feaa Mon Sep 17 00:00:00 2001
From: Kevin Jahns <kevin.jahns@rwth-aachen.de>
Date: Mon, 6 Oct 2014 16:56:15 +0200
Subject: [PATCH] examples

---
 doc/alphabetical_index.html                   |  2 +-
 doc/class/IwcConnector.html                   |  2 +-
 doc/class/JsonFramework.html                  |  2 +-
 doc/class/JsonType.html                       |  2 +-
 doc/class/JsonTypeWrapper.html                |  2 +-
 doc/class/PeerJsConnector.html                |  2 +-
 doc/class/TextFramework.html                  |  2 +-
 doc/class/WordType.html                       |  2 +-
 doc/class/XmlFramework.html                   |  2 +-
 doc/extra/LICENSE.txt.html                    |  2 +-
 doc/extra/README.md.html                      |  4 +--
 .../lib/Connectors/IwcConnector.coffee.html   |  2 +-
 .../Connectors/PeerJsConnector.coffee.html    |  2 +-
 .../lib/Connectors/TestConnector.coffee.html  |  2 +-
 doc/file/lib/Engine.coffee.html               |  2 +-
 .../lib/Frameworks/JsonFramework.coffee.html  |  2 +-
 .../lib/Frameworks/TextFramework.coffee.html  |  2 +-
 .../lib/Frameworks/XmlFramework.coffee.html   |  2 +-
 doc/file/lib/HistoryBuffer.coffee.html        |  2 +-
 doc/file/lib/Types/BasicTypes.coffee.html     |  2 +-
 doc/file/lib/Types/JsonTypes.coffee.html      |  2 +-
 .../lib/Types/StructuredTypes.coffee.html     |  2 +-
 doc/file/lib/Types/TextTypes.coffee.html      |  2 +-
 doc/file/lib/index.coffee.html                |  2 +-
 examples/PeerJs-Json/README.md                | 26 +++++++++++++++++-
 examples/TextEditing/README.md                | 25 ++++++++++++-----
 examples/XmlExample/README.md                 | 26 +++++++++++++++++-
 examples/temp_ex/README.md                    | 27 ++++++++++++++++++-
 28 files changed, 120 insertions(+), 34 deletions(-)

diff --git a/doc/alphabetical_index.html b/doc/alphabetical_index.html
index ea002c35..749dcec0 100644
--- a/doc/alphabetical_index.html
+++ b/doc/alphabetical_index.html
@@ -258,7 +258,7 @@
       </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/class/IwcConnector.html b/doc/class/IwcConnector.html
index 55d5abe6..c3391d7f 100644
--- a/doc/class/IwcConnector.html
+++ b/doc/class/IwcConnector.html
@@ -302,7 +302,7 @@ data from the received intent.</p>
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/class/JsonFramework.html b/doc/class/JsonFramework.html
index c3d70fd2..167fe639 100644
--- a/doc/class/JsonFramework.html
+++ b/doc/class/JsonFramework.html
@@ -335,7 +335,7 @@ JsonFramework was initialized (Depending on the HistoryBuffer implementation).</
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/class/JsonType.html b/doc/class/JsonType.html
index 24d7b9d8..ce7ee767 100644
--- a/doc/class/JsonType.html
+++ b/doc/class/JsonType.html
@@ -466,7 +466,7 @@ if (x.type === &quot;JsonType&quot;) {
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/class/JsonTypeWrapper.html b/doc/class/JsonTypeWrapper.html
index b3ef3ff7..a1d1b3da 100644
--- a/doc/class/JsonTypeWrapper.html
+++ b/doc/class/JsonTypeWrapper.html
@@ -139,7 +139,7 @@ console.log(w.newProperty == &quot;Awesome&quot;) # true!</code></pre>
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/class/PeerJsConnector.html b/doc/class/PeerJsConnector.html
index eb10aec3..c7c0c288 100644
--- a/doc/class/PeerJsConnector.html
+++ b/doc/class/PeerJsConnector.html
@@ -242,7 +242,7 @@ on how to do that with urls.</p>
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/class/TextFramework.html b/doc/class/TextFramework.html
index 79564c73..2d1105d4 100644
--- a/doc/class/TextFramework.html
+++ b/doc/class/TextFramework.html
@@ -356,7 +356,7 @@ JsonFramework was initialized (Depending on the HistoryBuffer implementation).</
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/class/WordType.html b/doc/class/WordType.html
index fa1ae503..757d8592 100644
--- a/doc/class/WordType.html
+++ b/doc/class/WordType.html
@@ -455,7 +455,7 @@ yatta.bind(textbox);</code></pre>
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/class/XmlFramework.html b/doc/class/XmlFramework.html
index f1a96169..1cc31b83 100644
--- a/doc/class/XmlFramework.html
+++ b/doc/class/XmlFramework.html
@@ -303,7 +303,7 @@ JsonFramework was initialized (Depending on the HistoryBuffer implementation).</
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/extra/LICENSE.txt.html b/doc/extra/LICENSE.txt.html
index 99af8c66..fbdd9174 100644
--- a/doc/extra/LICENSE.txt.html
+++ b/doc/extra/LICENSE.txt.html
@@ -38,7 +38,7 @@
       </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/extra/README.md.html b/doc/extra/README.md.html
index e4939e04..3c3815e3 100644
--- a/doc/extra/README.md.html
+++ b/doc/extra/README.md.html
@@ -76,7 +76,7 @@ But I would become really motivated if you gave me some feedback :) (<a href="ht
 </ul>
 <h2 id="support">Support</h2><p>Please report <em>any</em> issues to the <a href="https://github.com/DadaMonad/Yatta/issues">Github issue page</a>!
 I would appreciate if developers gave me feedback on how <em>convenient</em> the framework is, and if it is easy to use. Particularly the XML-support may not support every DOM-methods - if you encounter a method that does not cause any change on other peers,
-please state function name, and sample parameters. However, there are browser-specific features, that Yatta won&#39;t support.</p><h2 id="license">License</h2><p>Yatta! is licensed under the <a href="./LICENSE.txt">MIT License</a>.</p><a href="&#x6d;&#97;&#105;&#108;&#116;&#111;&#58;&#x6b;&#x65;&#x76;&#105;&#x6e;&#46;&#106;&#97;&#104;&#x6e;&#115;&#64;&#114;&#119;&#116;&#x68;&#45;&#x61;&#97;&#x63;&#104;&#101;&#x6e;&#x2e;&#100;&#101;">&#x6b;&#x65;&#x76;&#105;&#x6e;&#46;&#106;&#97;&#104;&#x6e;&#115;&#64;&#114;&#119;&#116;&#x68;&#45;&#x61;&#97;&#x63;&#104;&#101;&#x6e;&#x2e;&#100;&#101;</a>
+please state function name, and sample parameters. However, there are browser-specific features, that Yatta won&#39;t support.</p><h2 id="license">License</h2><p>Yatta! is licensed under the <a href="./LICENSE.txt">MIT License</a>.</p><a href="&#x6d;&#x61;&#105;&#x6c;&#x74;&#x6f;&#x3a;&#x6b;&#x65;&#118;&#x69;&#110;&#46;&#106;&#x61;&#104;&#x6e;&#115;&#x40;&#114;&#119;&#x74;&#104;&#x2d;&#x61;&#97;&#x63;&#x68;&#101;&#x6e;&#x2e;&#x64;&#x65;">&#x6b;&#x65;&#118;&#x69;&#110;&#46;&#106;&#x61;&#104;&#x6e;&#115;&#x40;&#114;&#119;&#x74;&#104;&#x2d;&#x61;&#97;&#x63;&#x68;&#101;&#x6e;&#x2e;&#x64;&#x65;</a>
 
 
 
@@ -85,7 +85,7 @@ please state function name, and sample parameters. However, there are browser-sp
       </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/file/lib/Connectors/IwcConnector.coffee.html b/doc/file/lib/Connectors/IwcConnector.coffee.html
index a5fece63..6438afe3 100644
--- a/doc/file/lib/Connectors/IwcConnector.coffee.html
+++ b/doc/file/lib/Connectors/IwcConnector.coffee.html
@@ -100,7 +100,7 @@
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/file/lib/Connectors/PeerJsConnector.coffee.html b/doc/file/lib/Connectors/PeerJsConnector.coffee.html
index 1bfb77b7..e3f0d38f 100644
--- a/doc/file/lib/Connectors/PeerJsConnector.coffee.html
+++ b/doc/file/lib/Connectors/PeerJsConnector.coffee.html
@@ -158,7 +158,7 @@
 </div>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/file/lib/Connectors/TestConnector.coffee.html b/doc/file/lib/Connectors/TestConnector.coffee.html
index 6bd2b51f..caf9933a 100644
--- a/doc/file/lib/Connectors/TestConnector.coffee.html
+++ b/doc/file/lib/Connectors/TestConnector.coffee.html
@@ -39,7 +39,7 @@
       </table>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/file/lib/Engine.coffee.html b/doc/file/lib/Engine.coffee.html
index 2c832e09..adffe77d 100644
--- a/doc/file/lib/Engine.coffee.html
+++ b/doc/file/lib/Engine.coffee.html
@@ -48,7 +48,7 @@
 </dl>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/file/lib/Frameworks/JsonFramework.coffee.html b/doc/file/lib/Frameworks/JsonFramework.coffee.html
index 8b63adec..53ceb4e3 100644
--- a/doc/file/lib/Frameworks/JsonFramework.coffee.html
+++ b/doc/file/lib/Frameworks/JsonFramework.coffee.html
@@ -60,7 +60,7 @@
 </dl>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/file/lib/Frameworks/TextFramework.coffee.html b/doc/file/lib/Frameworks/TextFramework.coffee.html
index aebc6e28..5c88b34e 100644
--- a/doc/file/lib/Frameworks/TextFramework.coffee.html
+++ b/doc/file/lib/Frameworks/TextFramework.coffee.html
@@ -60,7 +60,7 @@
 </dl>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/file/lib/Frameworks/XmlFramework.coffee.html b/doc/file/lib/Frameworks/XmlFramework.coffee.html
index 3cb3923c..bf6dd745 100644
--- a/doc/file/lib/Frameworks/XmlFramework.coffee.html
+++ b/doc/file/lib/Frameworks/XmlFramework.coffee.html
@@ -60,7 +60,7 @@
 </dl>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/file/lib/HistoryBuffer.coffee.html b/doc/file/lib/HistoryBuffer.coffee.html
index 3c12bc1d..1aad3ca5 100644
--- a/doc/file/lib/HistoryBuffer.coffee.html
+++ b/doc/file/lib/HistoryBuffer.coffee.html
@@ -48,7 +48,7 @@
 </dl>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/file/lib/Types/BasicTypes.coffee.html b/doc/file/lib/Types/BasicTypes.coffee.html
index 027633e0..3b12a439 100644
--- a/doc/file/lib/Types/BasicTypes.coffee.html
+++ b/doc/file/lib/Types/BasicTypes.coffee.html
@@ -39,7 +39,7 @@
       </table>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/file/lib/Types/JsonTypes.coffee.html b/doc/file/lib/Types/JsonTypes.coffee.html
index 2ee65a08..fe0be8ff 100644
--- a/doc/file/lib/Types/JsonTypes.coffee.html
+++ b/doc/file/lib/Types/JsonTypes.coffee.html
@@ -39,7 +39,7 @@
       </table>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/file/lib/Types/StructuredTypes.coffee.html b/doc/file/lib/Types/StructuredTypes.coffee.html
index 801c886e..6bc6df3b 100644
--- a/doc/file/lib/Types/StructuredTypes.coffee.html
+++ b/doc/file/lib/Types/StructuredTypes.coffee.html
@@ -39,7 +39,7 @@
       </table>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/file/lib/Types/TextTypes.coffee.html b/doc/file/lib/Types/TextTypes.coffee.html
index 1cf4da6a..9d8f7bf8 100644
--- a/doc/file/lib/Types/TextTypes.coffee.html
+++ b/doc/file/lib/Types/TextTypes.coffee.html
@@ -39,7 +39,7 @@
       </table>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/doc/file/lib/index.coffee.html b/doc/file/lib/index.coffee.html
index 1ee4f016..68625fd1 100644
--- a/doc/file/lib/index.coffee.html
+++ b/doc/file/lib/index.coffee.html
@@ -37,7 +37,7 @@
       </table>
     </div>
     <div id='footer'>
-  October 06, 14 15:25:31 by
+  October 06, 14 16:55:15 by
   <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
     Codo
   </a>
diff --git a/examples/PeerJs-Json/README.md b/examples/PeerJs-Json/README.md
index a290a3af..205d04b5 100644
--- a/examples/PeerJs-Json/README.md
+++ b/examples/PeerJs-Json/README.md
@@ -24,7 +24,31 @@ Therefore, you may also specify the server/port here, if you have set up your ow
 
 ```js
 var yatta, yattaHandler;
-Y.createPeerJsConnector({key: 'h7nlefbgavh1tt9'}, function(Connector, user_id){
+```
+
+
+This will connect to the server owned by the peerjs team.
+For now, you can use my API key.
+
+
+```js
+// var conn = {key: 'h7nlefbgavh1tt9'};
+```
+
+
+This will connect to one of my peerjs instances.
+I can't guaranty that this will be always up. This is why you should use the previous method with the api key,
+or set up your own server.
+
+
+```js
+var conn = {
+  host: "terrific-peerjs.herokuapp.com",
+  port: "", // this works because heroku can forward to the right port.
+  // debug: true,
+};
+
+Y.createPeerJsConnector(conn, function(Connector, user_id){
 ```
 
 
diff --git a/examples/TextEditing/README.md b/examples/TextEditing/README.md
index 259f7268..26b6b15e 100644
--- a/examples/TextEditing/README.md
+++ b/examples/TextEditing/README.md
@@ -28,15 +28,28 @@ First create the connector - the underlaying communication protocol.
 Here, we use the PeerJs connector. Its first parameter is the API key that you need to specify (see [website](http://peerjs.com/))
 
 
+This will connect to the server owned by the peerjs team.
+For now, you can use my API key.
+
+
+```js
+     // var conn = {key: 'h7nlefbgavh1tt9'};
+```
+
+
+This will connect to one of my peerjs instances.
+I can't guaranty that this will be always up. This is why you should use the previous method with the api key,
+or set up your own server.
+
+
 ```js
-    /*
-     var conn = {key: 'h7nlefbgavh1tt9'}; // this will connect to the server owned by the peerjs team.
-     */
     var conn = {
-      host: "127.0.0.1/", //"terrific-peerjs.herokuapp.com/",
-      port: 5000
+      host: "terrific-peerjs.herokuapp.com",
+      port: "", // this works because heroku can forward to the right port.
+      // debug: true,
     };
-    Y.createPeerJsConnector(conn , function(Connector, user_id){
+
+    Y.createPeerJsConnector(conn, function(Connector, user_id){
 ```
 
 
diff --git a/examples/XmlExample/README.md b/examples/XmlExample/README.md
index be4e5a23..9de24a9d 100644
--- a/examples/XmlExample/README.md
+++ b/examples/XmlExample/README.md
@@ -24,7 +24,31 @@ Therefore, you may also specify the server/port here, if you have set up your ow
 
 ```js
 var yatta, yattaHandler;
-Y.createPeerJsConnector({key: 'h7nlefbgavh1tt9'}, function(Connector, user_id){
+```
+
+
+This will connect to the server owned by the peerjs team.
+For now, you can use my API key.
+
+
+```js
+// var conn = {key: 'h7nlefbgavh1tt9'};
+```
+
+
+This will connect to one of my peerjs instances.
+I can't guaranty that this will be always up. This is why you should use the previous method with the api key,
+or set up your own server.
+
+
+```js
+var conn = {
+  host: "terrific-peerjs.herokuapp.com",
+  port: "", // this works because heroku can forward to the right port.
+  // debug: true,
+};
+
+Y.createPeerJsConnector(conn, function(Connector, user_id){
 
   yatta = new Y.XmlFramework(user_id, Connector);
 ```
diff --git a/examples/temp_ex/README.md b/examples/temp_ex/README.md
index 98dc87e0..1eaca8d9 100644
--- a/examples/temp_ex/README.md
+++ b/examples/temp_ex/README.md
@@ -24,7 +24,32 @@ Therefore, you may also specify the server/port here, if you have set up your ow
 
 ```js
 var yatta, yattaHandler;
-Y.createPeerJsConnector({key: 'h7nlefbgavh1tt9'}, function(Connector, user_id){
+```
+
+
+This will connect to the server owned by the peerjs team.
+For now, you can use my API key.
+
+
+```js
+// var conn = {key: 'h7nlefbgavh1tt9'};
+```
+
+
+This will connect to one of my peerjs instances.
+I can't guaranty that this will be always up. This is why you should use the previous method with the api key,
+or set up your own server.
+
+
+```js
+var conn = {
+  host: "terrific-peerjs.herokuapp.com",
+  port: "", // this works because heroku can forward to the right port.
+  // debug: true
+};
+
+
+Y.createPeerJsConnector(conn, function(Connector, user_id){
 ```