README.md in awesome_game_randomizer-0.1.1 vs README.md in awesome_game_randomizer-0.1.2

- old
+ new

@@ -1,37 +1,27 @@ -# AwesomeGameRandomizer +# <b>AwesomeGameRandomizer</b> -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/awesome_game_randomizer`. To experiment with that code, run `bin/console` for an interactive prompt. - -TODO: Delete this and the text above, and describe your gem - -## Installation - -Install the gem and add to the application's Gemfile by executing: - - $ bundle add awesome_game_randomizer - -If bundler is not being used to manage dependencies, install the gem by executing: - - $ gem install awesome_game_randomizer - -## Usage - -TODO: Write usage instructions here - -## Development - -After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment. - -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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org). - -## Contributing - -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/awesome_game_randomizer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/awesome_game_randomizer/blob/master/CODE_OF_CONDUCT.md). - -## License - -The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). - -## Code of Conduct - -Everyone interacting in the AwesomeGameRandomizer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/awesome_game_randomizer/blob/master/CODE_OF_CONDUCT.md). +##### Install awesome_game_randomizer gem +```` +gem install awesome_game_randomizer +```` +##### To use Gem: +```` +require 'awesome_game_randomizer' +```` +##### Flip a coin for heads or tails +```` +AwesomeGameRandomizer::Coin.flip +```` +##### Draws a random card from a 52 card deck +```` +AwesomeGameRandomizer::PlayingCard.draw +```` +##### Number of 6 sided dice to roll +```` +AwesomeGameRandomizer::Dice.roll(20) +```` +##### First number is the number of selected numbers +##### Second number is the range 1 to your number +```` +AwesomeGameRandomizer::Dice.roll(20) +````