README.md in software_challenge_client-0.1.0 vs README.md in software_challenge_client-0.1.1

- old
+ new

@@ -21,21 +21,36 @@ ## Usage See the example client in the example directory. +You can execute the example client by entering + +```console +ruby main.rb +``` + +in a shell (while being in the example directory). Note that the +software_challenge_client gem needs to be installed for this to work and a +server waiting for a manual client has to be running. + ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. 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 tags, and push -the `.gem` file to [rubygems.org](https://rubygems.org). +install`. + +### Releasing + +To release a new version, update the version number in +`lib/software_challenge_client/version.rb` and update RELEASES.md. 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). ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/CAU-Kiel-Tech-Inf/socha_ruby_client. This project