Skip to content

Commit

Permalink
improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SKoschnicke committed Nov 22, 2017
1 parent 065adb7 commit b0cb53b
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ 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
`software_challenge_client` gem needs to be installed for this to work and a
server waiting for a manual client has to be running.

## Documentation
Expand Down Expand Up @@ -91,10 +91,12 @@ pass.
### 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).
`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). You may also use the `release.sh` script
which executes `bundle exec rake release` in a suitable docker container.

## Contributing

Expand Down

0 comments on commit b0cb53b

Please sign in to comment.