progress_bar 0.3.0 → 0.3.1

data/README.mkd

@@ -2,8 +2,8 @@
 # ProgressBar
 
 *ProgressBar* is a simple Ruby library for displaying progress of
-long-running tasks on the console. It is intended to be easy to use
-first, and configurable for additional needs.
+long-running tasks on the console. It is intended to be as simple to use
+as possible.
 
 # Installation
 
@@ -44,22 +44,33 @@ pass a number to `#increment!`
 
     bar.increment! 42
 
-## The Configurable Way
 
-    bar = ProgressBar.new do |cfg|
-      cfg.width = 60
-      cfg.max   = 1000
-      cfg.color = true
-      cfg.meters = [:bar, :eta]
+## Picking the meters
 
-      cfg.bar.width = 40
-      cfg.bar.fill = '#'
-      cfg.bar.empty = ' '
-      cfg.bar.prefix = '['
-      cfg.bar.suffix = ']'
+By default, ProgressBar will use all available meters (this will
+probably change). To select which meters you want, and in which order,
+pass them to the constructor:
 
-      cfg.eta.format = "%H:%M:%S"
-    end
+    bar = ProgressBar.new(100, :bar, :rate, :eta)
+
+
+### Available Meters
+
+ * `:bar` -- The bar itself, fills empty space with "#"s. Ex: `[###
+   ]`.
+ * `:counter` -- Number of items complete, over the max. Ex: `[ 20/100]`
+ * `:percentage` -- Percentage of items in the maximum. Ex: `[ 42%]`
+ * `:elapsed` -- Time elapsed (since the ProgressBar was initialized.
+   Ex: `[00:42]`
+ * `:eta` -- Estimated Time remaining. Given the rate that items are
+   completed, a guess at how long the rest will take. Ex: `[01:30]`
+ * `:rate` -- The rate at which items are being completed. Ex: `[
+   42.42/s]`
+
+Run the tests to see examples of all the formats, with different values
+and maximums.
+
+    `rspec test/*_test.rb`
 
 
 

data/lib/progress_bar/version.rb

@@ -1,3 +1,3 @@
 module ProgressBar
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/progress_bar.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name        = "progress_bar"
   s.version     = ProgressBar::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Paul Sasauskas"]
+  s.authors     = ["Paul Sadauskas"]
   s.email       = ["psadauskas@gmail.com"]
   s.homepage    = "http://www.github.com/paul/progress_bar"
   s.summary     = %q{Simple Progress Bar for output to a terminal}

metadata

@@ -2,10 +2,10 @@
 name: progress_bar
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
-- Paul Sasauskas
+- Paul Sadauskas
 autorequire: 
 bindir: bin
 cert_chain: []