README.md in cat_ipsum-0.1.1 vs README.md in cat_ipsum-0.2.1

- old
+ new

@@ -1,11 +1,9 @@ # CatIpsum -Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cat_ipsum`. To experiment with that code, run `bin/console` for an interactive prompt. +This gem generates fake text based on cats' typical activities. Just use it like another Lorem Ipsum version. -TODO: Delete this and the text above, and describe your gem - ## Installation Add this line to your application's Gemfile: ```ruby @@ -20,16 +18,32 @@ $ gem install cat_ipsum ## Usage -TODO: Write usage instructions here +#### Methods -## Development +```ruby +CatIpsum.sentence +# => "Swat at dog, inspect anything brought into the house, play time" -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. +CatIpsum.paragraph +# => "Shake treat bag, chase imaginary bugs, why must they do that. Nap all day, stand in doorway, yawn so much. Play time, chew ipad power cord, ignore the human. Need to chase tail, hide when guests come over, throwup on your pillow. Hate dog, mark territory, go crazy" +``` -To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). +`CatIpsum.sentences` and `CatIpsum.paragraphs` returns arrays of their original methods. -## Contributing +`CatIpsum.phrase` and `CatIpsum.phrases` are aliases to `CatIpsum.sentence` and `CatIpsum.sentence`. -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cat_ipsum. +#### Working with randomizing seeds + +You can specify your seed to generate repeatable data. Also, seed can be reseted by `CatIpsum.reset!` method. +Example: + +```ruby +CatIpsum.sentence +# => "Leave hair everywhere, shake treat bag, missing until dinner time" +CatIpsum::Random.reset! +# => true +CatIpsum.sentence +# => "Leave hair everywhere, shake treat bag, missing until dinner time" +```