Skip to content
Browse files

added readme

  • Loading branch information...
1 parent 410cf38 commit d272f0e0446b8b8c9ac4933b89b4de428641037b @jgallen23 committed May 25, 2012
Showing with 28 additions and 0 deletions.
  1. +28 −0 README.md
View
28 README.md
@@ -0,0 +1,28 @@
+# Cube Dashboard
+
+Generic dashboard for [cube](http://square.github.com/cube/).
+
+## Features
+
+* Powered by config file
+* Can have multiple dashboards
+* iPhone/iPad optimized for saving on home screen
+* auto fit to screen
+
+## Future
+
+* auto update charts on resize
+* better looking dropdowns
+* auto height?
+
+##Installation
+
+ npm install -g cube-dashboard
+
+##Usage
+
+change the sample-config.json and then run:
+
+ cube-dashboard config.json
+
+you can also run `cube-dashboard --help` for all the options

0 comments on commit d272f0e

Please sign in to comment.
Something went wrong with that request. Please try again.