doc updates

buglabs · Dec 11, 2015 · 678d133 · 678d133
1 parent 90349ad
commit 678d133
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 3 deletions.
diff --git a/Social Mobile Template/README.md b/Social Mobile Template/README.md
@@ -32,9 +32,9 @@ After loading the cloned dashboard, the configuration dialog will pop-up.
 
 In emulator mode, the template is set up to respond to devices which are connected via the Try It Now feature on the dweet.io website.  We recommend the following set-up in order to experience all of the template's functionality from the comforts of your desk:
 
-Master device - your laptop
-SubUser1 - your smartphone
-SubUser2 - random smartphone from dweet.io/see
+*    Master device - your laptop
+*    SubUser1 - your smartphone
+*    SubUser2 - random smartphone from dweet.io/see
 
 
 Begin by navigating to http://dweet.io on your Master device.  Click the orange Try It Now feature (making sure to *enable location services* if it is not already).  

diff --git a/Social Mobile Template/doc_images/7.png b/Social Mobile Template/doc_images/7.png
diff --git a/Social Mobile Template/doc_images/8.png b/Social Mobile Template/doc_images/8.png
diff --git a/Twitter Widget/README.md b/Twitter Widget/README.md
@@ -0,0 +1,26 @@
+Twitter Widget
+=================================
+
+# Table of Contents
+*   [Introduction](#introduction)
+*   [How to Use](#how-to-use)
+
+
+Introduction
+------------
+The Twitter widget creates a table view to see multiple stats in real-time along with a Tweet button.  Once the Tweet button is pressed, the current data is wrapped up and a Twitter pop-up allows you to confirm sending of the tweet.
+
+An Error message will show if you have gone over the Twitter character limit. There is no datasource limit in the widget itself, so it is possible to run over the 140 character limit of Twitter.  
+
+How to Use
+-----------
+Download the source files (jquery.tablescroll.js and twitterWidget.js) from github, and host on your favorite server or a file storage service (we prefer Dropbox).
+Add the source files via the Developer Console.  (Note: if using dropbox, remember to change the end of the share link URL to '?dl=1' )
+![screen1](./doc_images/1.png)
+
+Refresh the page and you will now see the Twitter widget in the list of available widgets.  Adding data to the widget is the same as any other widget in freeboard. First, you select Twitter in the drop down menu of widget options, then you add data by clicking on the +DATASOURCE button. You can add as many data streams as you like by pressing the +ADD button as shown below:
+![screen2](./doc_images/2.png)
+
+You will now see the table updating with live data and the Tweet button.  Click the Tweet button at any point to create the tweet and confirm the send.
+
+![screen3](./doc_images/3.png)
diff --git a/Twitter Widget/doc_images/1.png b/Twitter Widget/doc_images/1.png
diff --git a/Twitter Widget/doc_images/2.png b/Twitter Widget/doc_images/2.png
diff --git a/Twitter Widget/doc_images/3.png b/Twitter Widget/doc_images/3.png