README.md in ryan-1.0.0 vs README.md in ryan-1.1.0

- old
+ new

@@ -1,35 +1,35 @@ -# Ryan +# Ryan [![Gem Version](https://badge.fury.io/rb/ryan.svg)](http://badge.fury.io/rb/ryan) [![Build Status](https://travis-ci.org/ridiculous/ryan.svg)](https://travis-ci.org/ridiculous/ryan) -A wrapper around the awesome [RubyParser](https://github.com/seattlerb/ruby_parser) gem that provides an OO interface for +A wrapper around the awesome [RubyParser](https://github.com/seattlerb/ruby_parser) gem that provides an OO interface for reading Ruby code. ## Installation ```ruby -gem 'ryan' +gem 'ryan', '~> 1.1.0' ``` ## Usage -Give Ryan a Ruby file to play with. Test it out in an IRB session with `bin/console` +Give Ryan a Ruby file or code string to play with. Test it out in an IRB session with `bin/console` ```ruby -ryan = Ryan.new FIXTURE_ROOT.join('report.rb') -ryan.name +ryan = Ryan.new FIXTURE_ROOT.join('report.rb') # or Ryan.new("<valid ruby code here>") +ryan.name #=> "Report" ryan.class? #=> true ryan.module? #=> false ryan.initialization_args #=> [:message] -ryan.funcs.length +ryan.funcs.length #=> 12 -ryan.funcs.reject(&:private?).length +ryan.funcs.reject(&:private?).length #=> 10 -ryan.funcs.first.name +ryan.funcs.first.name #=> :enqueue ``` ### Assignments @@ -90,10 +90,10 @@ #=> "returns UserMailer.spam(user).deliver_now" ``` ## Development -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/ridiculous/ryan.