moar readme

1 files changed, 76 insertions, 38 deletions

diff --git a/README.md b/README.md
index d024da9..13b00c7 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Dashing!
 
-<!-- CI status? -->
+A handsome dashboard framework solution
 
 ## Introduction
 
@@ -9,9 +9,10 @@ Dashing is a framework for building web-based dashboards.
 Features:
 
  - Custom widgets! Built using whatever HTML/Coffeescript wizardry you posses
- - Multiple dashboards! You can have many different views all hosted by the same app
- - Shareable widgets!
- - ...
+ - Multiple dashboards! You can have many different views all hosted in the same location
+ - Shared widgets! It's easy to have have the same widget show up on different dashboards
+ - Push or pull data, you decide!
+ - Responsive grid layout! Your dashboard will look good on any sized screen
 
 ## Installation and Setup
 
@@ -23,7 +24,7 @@ Features:
 
     ```dashing new sweet_dashboard_project```
 
-  3. Change your directory to ```sweet_dashboard_project``` and start the Dashing
+  3. Change your directory to ```sweet_dashboard_project``` and start Dashing
 
     ```dashing start```
 
@@ -31,23 +32,32 @@ Features:
 
 ## Building a dashboard
 
-```main.erb``` contains the layout for the default dashboard which is accessible at ```/```. You can add additional dashboards with ```COMMAND new_view``` which creates a ```new_view.erb``` file in ```dashboards/```. That new view will be accessible at ```localhost:3000/new_view```
+```main.erb``` contains the layout for the default dashboard which is accessible at ```/```.
+You can add additional dashboards with by running ```dashing COMMAND THINGY new_view``` which creates a ```new_view.erb``` file in ```dashboards/```.
+That new view will be accessible at ```localhost:3000/new_view```
 
-Widgets are represented by a ```div``` with ```data-id``` and ```data-view``` attributes. For example:
+## Widgets
+
+Widgets are represented by a ```div``` element with ```data-id``` and ```data-view``` attributes. eg:
 
 ```HTML
 <div data-id="sample" data-view="SweetWidget"></div>
 ```
 
-represents a dashboard with a single widget.
+The ```data-id``` attribute is used to set the **widget ID** which will be used when to push data to the widget. Two widgets can have the same widget id, allowing you to have the same widget in multiple dashboards.
 
-The ```data-id``` is used to set the widget_id which will be used when we push data to the widget. widget_ids can be shared across dashboards.
+```data-view``` specifies the type of widget what will be used. This field is case sensitive and must match the coffeescript class of the widget. See making your own widget section for more details.
 
-```data-view``` specifies the type of widget what will be used. This field is case sensitive and must match the name of coffeescript class. See making your own widget.
+This ```<div>``` can also be used to configure your widgets. For example, the pre-bundled widgets let you set a title with ```data-title="Widget Title"```.
 
-Getting the style and layout right when you have multiple widgets is hard, that's why we've done it for you. By default Dashing uses [masonry](http://masonry.desandro.com/) to produce a grid layout.
+### Layout
+
+Getting the style and layout right when you have multiple widgets is hard, that's why we've done it for you. By default Dashing uses [masonry](http://masonry.desandro.com/) to produce a grid layout. If it can, your dashboard will fill the screen with 5 columns. If there isn't enough room though, widgets will be reorganized to fit into fewer columns until you are left with a single column
+
+Examples here?
+
+Masonry requires that your widgets be contained within a ```<ul>``` element as follows:
 
-#### Example
 ```HTML
 <ul class="list-nostyle clearfix">
   <li class="widget-container">
@@ -62,33 +72,51 @@ Getting the style and layout right when you have multiple widgets is hard, that'
 </ul>
 ```
 
-## Making you own widget
+### Making you own widget
 
-To make your own run ```dashing generate sweet_widget``` which will create template files in the ```widget/``` folder or your project.
+A widget consists of three parts:
 
-### sweet_widget.html
+ - an html file used for layout and bindings
+ - a scss file for style
+ - a coffeescript file which allows you to operate on the data
+
+To make your own run ```dashing generate sweet_widget``` which will create scaffolding files in the ```widget/``` folder or your project.
+
+#### sweet_widget.html
 
 Contains the HTML for you widget.
+We use [batman bindings](http://batmanjs.org/docs/batman.html#batman-view-bindings-how-to-use-bindings) in order to update the content of a widget.
+In the example below, updating the title attribute of the coffeescript object representing that widget will set the innerHTML of the ```<h1>``` element.
+Dashing provides a simple way to update your widgets attributes through a push interface and a pull interface. See the Getting Data into Dashing section.
 
-#### Example
+##### Example
 ```html
 <h1 data-bind="title"></h1>
 
 <h3 data-bind="text"></h3>
 ````
 
-### sweet_widget.coffee
+#### sweet_widget.coffee
 
-#### Example
+This coffee script file allows you to perform any operations you wish on your widget. In the example below we can initialize things with the constructor method.
+We can also manipulate the data we recieve from data updates. Data will be the JSON object you pass in.
+
+##### Example
 ```coffeescript
 class Dashing.SweetWidget extends Dashing.Widget
-  source: 'widget_text'
 
-  onData(data) ->
-    #stuff?
+  constructor: ->
+    super
+    @set('attr', 'wooo')
+
+  onData: (data) ->
+    super
+    @set('cool_thing', data.massage.split(',')[2]
 ```
 
-### sweet_widget.scss
+#### sweet_widget.scss
+
+##### Example
 ````scss
 $text_value-color:       #fff;
 $text_title-color:       lighten($widget-text-color, 30%);
@@ -105,11 +133,14 @@ $text_title-color:       lighten($widget-text-color, 30%);
 
 ## Getting data into Dashing
 
-### Jobs
+Providing data to widgets is easy. You specify which widget you want using a widget id. Dashing expects the data you send to be in JSON format.
+Upon getting data, dashing mixes the json into the widget object. So it's easy to update multiple attributes within the same object.
 
-Dashing uses [rufus-scheduler](http://rufus.rubyforge.org/rufus-scheduler/) to schedule jobs. You can make a new job with ```things job super_job``` which will create a file in the jobs folder called ```super_job.rb```.
+### Jobs (poll)
 
-Use ```send_event('WIDGET_ID', {text: SAMPLE_DATUMS})```
+Dashing uses [rufus-scheduler](http://rufus.rubyforge.org/rufus-scheduler/) to schedule jobs.
+You can make a new job with ```dashing job super_job``` which will create a file in the jobs folder called ```super_job.rb```.
+Data is sent to a widget using the ```send_event(widget_id, json_formatted_data)``` method.
 
 #### Example
 
@@ -122,7 +153,8 @@ end
 
 ### Push
 
-You can also push data directly to your dashboard! Post the data you want in json to ```/widgets/widget_id```. You will also have to include your auth_token (which can be found in ```config.ru```) as part of the json object.
+You can also push data directly to your dashboard! Post the data you want in json to ```/widgets/widget_id```.
+For security, you will also have to include your auth_token (which can be found in ```config.ru```) as part of the json object.
 
 #### Example
 ```bash
@@ -133,20 +165,26 @@ or
 
 ```ruby
 HTTParty.post('http://ADDRESS/widgets/widget_id',
-  :body => {
-    auth_token: "YOUR_AUTH_TOKEN",
-    text: "Weeeeee",
-  }.to_json)
+  :body => { auth_token: "YOUR_AUTH_TOKEN", text: "Weeeeee"}.to_json)
 ```
 
-## Licensing
+## Misc
 
-This code is released under the MIT license. Please read the MIT-LICENSE file for more details
+### Deploying to heroku
 
-TODO
-====
+### Using omni-auth
+
+## Dependencies
+
+ - [Sinatra](http://www.sinatrarb.com/)
+ - [batman.js](http://batmanjs.org/)
+ - [rufus-scheduler](http://rufus.rubyforge.org/rufus-scheduler/)
+ - [Thor](https://github.com/wycats/thor/)
+ - [jQuery-knob](http://anthonyterrien.com/knob/)
+ - [masonry](http://masonry.desandro.com/)
+ - [thin](http://code.macournoyer.com/thin/)
+ - [Sass](http://sass-lang.com/)
+
+## Licensing
 
-- tests
-- investigate if Dir.pwd is the best approach to get the local directory
-- Create githubpages
-- Open source!
+This code is released under the MIT license. See ```MIT-LICENSE``` file for more details
\ No newline at end of file