Permalink
Browse files

updated README

  • Loading branch information...
1 parent 8ce694d commit 7f2600a6110f289916813b1e1301c2d534c3188a @scjudd committed Sep 18, 2011
Showing with 12 additions and 2 deletions.
  1. +12 −2 README → README.md
View
@@ -1,4 +1,12 @@
-#!/usr/bin/env ruby
+giftcards
+=========
+
+A ruby library to check the balance on various gift cards
+
+Example
+-------
+
+```ruby
require 'giftcards'
cards = CardsArray.new([
@@ -11,4 +19,6 @@ cards.sort_by_balance!
cards.each do |c|
puts "#{c.masked_number}: #{c.balance_as_s}"
end
-puts "Total: #{cards.total_as_s}"
+puts "Total: #{cards.total_as_s}"
+```
+

0 comments on commit 7f2600a

Please sign in to comment.