appboard 1.0.1 → 1.0.2

data/README.md

@@ -0,0 +1,135 @@
+appboard
+===========
+[appboard](http://appboard.me/) is real-time dashboard for your application and business.
+
+Dashboards tell people what's happening and should help them immediately recognize what needs their attention. Just like the dashboard of a car, which provides easily monitored measures of speed, remaining fuel, oil level, battery strength, engine trouble, and so on, a application and business information dashboard provides an overview that can be assimilated quickly.
+
+Further reading:
+
+* [Home page](http://appboard.me/)
+* [The essential documentation](http://appboard.me/docs)
+* [List of available widgets](http://appboard.me/docs/widgets)
+
+
+NOTE: We are currently in private beta. Please let me know (eugene@appboard.me) if you'd like an invite.
+
+
+Gem Installation
+----------------
+
+Install the heroku gem if you haven't already:
+
+    $ gem install appboard
+
+Note that appboard does not require ActiveSupport or Rails.  You can safely use it in your own Ruby projects.
+
+Local setup
+-----------
+
+Before using appboard in your application, you need to let appboard know your API key, you do this (e.g. in an initializer):
+
+    require 'rubygems'
+    require 'appboard'
+
+    Appboard.settings ({ :apiKey => "abcd1234" })
+
+or you could define API key in call block:
+
+    require 'rubygems'
+    require 'appboard'
+
+    Appboard.pub {
+        apiKey "abcd1234"
+    
+        widget('some name here') {
+		    uid "abcd1234"
+
+		    data do {
+			    # Data is here		
+		    }
+    	}
+    }
+
+
+Deploying to Heroku
+-------------------
+To use [appboard](http://appboard.me/) on Heroku, install the appboard add-on:
+
+    $ heroku addons:add appboard
+
+
+You can also do this from the Resources section of your application's configuration page on Heroku.
+
+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'].
+
+
+Usage
+-----
+
+There is several options how you could use API:
+
+*publish each widget separately*
+
+    require 'rubygems'
+    require 'appboard'
+
+    Appboard.settings ({ :apiKey => "abcd1234" })
+
+    widget = Appboard.widget('some name here') {
+	    uid "abcd1234"
+
+	    data do {
+		    # Data is here		
+	    }
+    }
+
+    response = widget.pub    			# publish data on appboard.me
+
+    response.success?     # => true
+    response.code         # => 200
+
+
+*publish few widgets at once*
+
+    require 'rubygems'
+    require 'appboard'
+
+    Appboard.settings ({ :apiKey => "abcd1234" })
+
+
+    Appboard.pub {
+        apiKey "abcd1234"
+    
+        widget('widget1') {
+		    uid "abcd1234"
+
+		    data do {
+			    # Data is here		
+		    }
+    	 }
+        widget('widget2') {
+		    uid "abcd4321"
+
+		    data do {
+			    # Data is here		
+		    }
+    	 }
+    }
+
+
+    widget = Appboard.widget('widget1') 			# after you could access widget by name 
+
+
+NOTE:  Don't forget to specify your apiKey and widget identifier.
+
+
+### What Should My Request Look Like? ###
+
+Each widget has its own page on [our documentation](http://appboard.me/docs). 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). 
+
+Copyright
+-----------
+
+Copyright (c) 2011 appboard.me. See LICENSE for details.
+
+

data/lib/appboard/version.rb

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

data/lib/appboard.rb

@@ -23,9 +23,9 @@ module Appboard
         @apiKey                                                                                     
     end                         
 
-    # Start the appboard loop
+    # Publish all defined widgets in block
     #
-    # appboard.start {
+    # appboard.pub {
     #    # Do stuff in here
     # }
     #
@@ -35,7 +35,7 @@ module Appboard
     #
     # Refer to default config below for how to set these as defaults
     #
-    def start(options = {}, &block)
+    def pub(options = {}, &block)
       @config = settings.update(options)
 	
       self.instance_eval(&block) if block_given?

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: appboard
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - appboard.me
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-24 00:00:00 -04:00
+date: 2011-06-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -87,7 +87,7 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README
+- README.md
 files: 
 - lib/appboard.rb
 - lib/appboard/bootstrap.rb
@@ -95,7 +95,7 @@ files:
 - lib/appboard/version.rb
 - lib/appboard/widget.rb
 - LICENSE.txt
-- README
+- README.md
 has_rdoc: true
 homepage: https://github.com/appboard/appboard
 licenses: []