appboard 1.0.8 → 1.0.9

data/README.md

@@ -18,7 +18,7 @@ NOTE: We are currently in private beta. Please let me know (dev@appboard.me) if
 Gem Installation
 ----------------
 
-Install the heroku gem if you haven't already:
+Install the appboard gem if you haven't already:
 
     $ gem install appboard
 
@@ -69,6 +69,37 @@ You can also do this from the Resources section of your application's configurat
 This will automatically create you an appboard.me account and create an default dashboard, and fill will set the Heroku configuration variables variables ENV['APPBOARD_API_URL'] and ENV['APPBOARD_API_KEY'].
 
 
+### Access your dashboard ###
+
+Now you could access your dashboard (with default configuration) by following url: http://appboard.me/a/{appName}
+
+Where,
+
+* {appName} - is name of application in Heroku.
+
+_e.g. for application quiet-sky-73 url will be http://appboard.me/a/quiet-sky-73_
+
+or, throw Heroku dashboard:
+
+* open Heroku dashboard
+* go to Resources of your application
+* on bottom of the page in _Installed Add-ons_ section you will find Appboard Test, click on it. And you will redirected on your appboard dashboard.
+
+### Getting apiKey ###
+
+You will need **apiKey** to setup or push data from local environment, application deployed on Heroku will get it from configuration variables.
+
+
+Steps are following:
+
+* open Heroku dashboard
+* go to Resources of your application
+* on bottom of the page in _Installed Add-ons_ section you will find Appboard Test, click on it. And you will redirected on your appboard dashboard.
+* on top of the page you will see _gear_, clock on it. Dasboard control pannel will appear, and on it you will find *apiKey*.
+
+
+
+
 Usage
 -----
 
@@ -79,8 +110,13 @@ After creating account (or deploying addon on Heroku) simple dashboard will be c
 
 In order to update or create new dashboard you will need to setup it, and the moment this supported only via Ruby GEM.
 
-Supported widget sizes are: 1x1, 1x2, 1x3, 2x1, 2x2, 2x3, 3x1, 3x2 and 3x3.
-Supported widget types are: Clock, Single Number, Alert, Bubble Chart, Funnel Chart, Line Chart, Bar Chart, Column Chart, Pie Chart, Radial Gauge, Filler Gauge. Check out [list of available widgets](http://appboard.me/docs/widgets). We are continue working over new nice widgets!
+You will need to define dashboard and place widgets in it. And there is supported widget parameters:
+
+* size: 1x1, 1x2, 1x3, 2x1, 2x2, 2x3, 3x1, 3x2 and 3x3.
+* type: Clock, Single Number, Alert, Bubble Chart, Funnel Chart, Line Chart, Bar Chart, Column Chart, Pie Chart, Radial Gauge, Filler Gauge. 
+Check out [list of available widgets](http://appboard.me/docs/widgets). 
+
+We are continue working over new nice widgets!
 
 There is simple example that updates default dashboard with new configuration:
 
@@ -118,11 +154,11 @@ You can access this data easily:
 
     uidMyIndicator1 = Appboard.widget('my indicator1').uid
 
-Note: If you are running this on local environment you will need to define _*apiKey*_ before calling Appboard.setup, on Heroku apiKey will be injected during deploying appboard addon.
+_Note:_ If you are running this on local environment you will need to define _*apiKey*_ before calling Appboard.setup, on Heroku apiKey will be injected during deploying appboard addon.
 
     Appboard.settings = { :apiKey => '...', :debug => true }
 
-You can find more examples in our Git repository: [one](https://github.com/appboard/appboard/blob/master/examples/setupdashboard1.rb), [two](https://github.com/appboard/appboard/blob/master/examples/setupdashboard2.rb) and [three](https://github.com/appboard/appboard/blob/master/examples/setupdashboard3.rb)
+You can find more examples for dashboard setup in our Git repository: [one](https://github.com/appboard/appboard/blob/master/examples/setupdashboard1.rb), [two](https://github.com/appboard/appboard/blob/master/examples/setupdashboard2.rb) and [three](https://github.com/appboard/appboard/blob/master/examples/setupdashboard3.rb)
 
 **Pushing your data to Widget**
 
@@ -175,7 +211,7 @@ _by widget uid (unique identifier)_ - other way to push data to widget is define
 
 Each widget has its own page on this site. That page contains all the information you need in order to start working with the widget, including descriptions of data model (a piece that represents some kind of data). 
 
-More examples for different widgets you could find in "our repository":https://github.com/appboard/appboard/tree/master/examples on GitHub.
+More examples for different widgets you could find in [our repository](https://github.com/appboard/appboard/tree/master/examples) on GitHub.
 
 
 NOTE:  Don't forget to specify your apiKey and widget identifier.

data/examples/singlenumber.rb

@@ -5,7 +5,7 @@ require 'appboard'
 # Updates Singge Number on Dashboard (see http://appboard.me/docs/singlenumber)
 # Don't forget to specify your apiKey and widget identifier.
 #
-Appboard.settings = { :apiKey => 'wOUpOJeOozcgPdZa', :url => 'http://localhost:9000', :debug => true }
+Appboard.settings = { :apiKey => 'wOUpOJeOozcgPdZa', :debug => true }
 
 Appboard.push {
   widget() {

data/lib/appboard/version.rb

@@ -2,7 +2,7 @@ module Appboard #:nodoc:
   module Version #:nodoc:
     MAJOR = 1
     MINOR = 0
-    TINY  = 8
+    TINY  = 9
      
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: appboard
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 1
   - 0
-  - 8
-  version: 1.0.8
+  - 9
+  version: 1.0.9
 platform: ruby
 authors: 
 - appboard.me
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-20 00:00:00 -04:00
+date: 2011-07-21 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency