README.md in codebreaker_manfly-0.1.1 vs README.md in codebreaker_manfly-0.1.2
- old
+ new
@@ -1,43 +1,35 @@
# Codebreaker
-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/codebreaker`. To experiment with that code, run `bin/console` for an interactive prompt.
+Codebreaker is a logic game in which a code-breaker tries to break a secret code created by a code-maker. The code-maker, which will be played by the application we’re going to write, creates a secret code of four numbers between 1 and 6.
-TODO: Delete this and the text above, and describe your gem
+The code-breaker then gets some number of chances to break the code. In each turn, the code-breaker makes a guess of four numbers. The code-maker then marks the guess with up to four + and - signs.
+A + indicates an exact match: one of the numbers in the guess is the same as one of the numbers in the secret code and in the same position.
+
+A - indicates a number match: one of the numbers in the guess is the same as one of the numbers in the secret code but in a different position.
+
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'codebreaker_manfly'
+gem 'codebreaker_manfly', '~> 0.1.0'
```
And then execute:
$ bundle install
Or install it yourself as:
- $ gem install codebreaker
+ $ gem install codebreaker_manfly
## Usage
-TODO: Write usage instructions here
+To use this game it should be installed in a console or web vesion of the game
-## Development
+Create an instance of the game:
-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.
+game = Codebreacker::Game.new
-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]/codebreaker. 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]/codebreaker/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 Codebreaker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/codebreaker/blob/master/CODE_OF_CONDUCT.md).
+During instantiation you can set matcher (object that will be used for guesses matching) and storage (object that will be used for storing scores).
\ No newline at end of file