From 57afd3fed0fb96cf664dbed4de829d1f69176b2d Mon Sep 17 00:00:00 2001 From: Wesley Ellis Date: Wed, 8 Aug 2012 18:12:33 -0400 Subject: moar readme --- README.md | 114 +++++++++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 76 insertions(+), 38 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d024da9..13b00c7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Dashing! - +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
``` -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 ```
``` 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 ```