Permalink
Browse files

Update README

  • Loading branch information...
rrrene committed Jan 21, 2014
1 parent 2589732 commit b27b5931cde3e7691eac5a5bcec813d0a9d4464b
Showing with 41 additions and 7 deletions.
  1. +1 −1 Gemfile
  2. +39 −5 README.md
  3. +1 −1 lib/sparkr/version.rb
View
@@ -1,6 +1,6 @@
source 'https://rubygems.org'
-# Specify your gem's dependencies in homecoming.gemspec
+# Specify your gem's dependencies in sparkr.gemspec
gemspec
gem 'simplecov', :require => false, :group => :test
View
@@ -1,29 +1,63 @@
# Sparkr
-TODO: Write a gem description
+Sparkr is a port of [spark](https://github.com/holman/spark) for Ruby.
+
+It let's you create sparklines for your Ruby CLIs: ▁▂▃▅▇
## Installation
Add this line to your application's Gemfile:
- gem 'Sparkr'
+ gem 'sparkr'
And then execute:
$ bundle
Or install it yourself as:
- $ gem install Sparkr
+ $ gem install sparkr
+
## Usage
-TODO: Write usage instructions here
+### Shell
+
+After installation, just run `sparkr` and pass it a list of numbers, like
+you would with [spark](https://github.com/holman/spark). The output is what
+you would expect:
+
+ $ sparkr 0 30 55 80 33 150
+ ▁▂▃▅▂▇
+
+### Ruby
+
+The real reason for this port:
+
+ Sparkr.sparkline([0,30,55,80,33,150])
+ # => "▁▂▃▅▂▇"
+
## Contributing
-1. Fork it ( http://github.com/<my-github-username>/Sparkr/fork )
+1. Fork it ( http://github.com/rrrene/sparkr/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+
+## Author
+
+René Föhring (@rrrene)
+
+
+## Credits
+
+Sparkr would not exist without Zach Holman's [spark](https://github.com/holman/spark).
+
+
+## License
+
+Sparkr is released under the MIT License. See the LICENSE.txt file for further
+details.
View
@@ -1,3 +1,3 @@
module Sparkr
- VERSION = "0.0.1"
+ VERSION = "0.1.0"
end

0 comments on commit b27b593

Please sign in to comment.