Merge pull request #128 from rtyler/minor-doc-fixes

Minor doc fixes
This commit is contained in:
R. Tyler Croy 2015-09-30 09:51:42 -07:00
commit 9f8fbe381c
2 changed files with 18 additions and 1 deletions

View File

@ -1,6 +1,6 @@
# Hermann
[![Gitter chat](https://badges.gitter.im/lookout/Hermann.png)](https://gitter.im/lookout/Hermann) [![Build Status](https://travis-ci.org/lookout/hermann.svg?branch=master)](https://travis-ci.org/lookout/hermann)
[![Gitter chat](https://badges.gitter.im/reiseburo/hermann.png)](https://gitter.im/reiseburo/hermann) [![Build Status](https://travis-ci.org/reiseburo/hermann.svg?branch=master)](https://travis-ci.org/reiseburo/hermann)
A Ruby gem implementing a Kafka Publisher and Consumer

17
RELEASING.md Normal file
View File

@ -0,0 +1,17 @@
# Releasing Hermann
Hermann is a multi-platform gem, which means that two actual `.gem` files need
to be built and uploaded to [rubygems.org](https://rubygems.org/gems/hermann).
Here's the current process that [I](https://github.com/rtyler) use:
* `rvm use ruby@rubygems` (*switch to MRI*)
* `bundle install && rake` (*ensure that MRI tests pass*)
* `rvm use jruby@rubygems` (*switch to JRuby*)
* `bundle install && rake` (*ensure that the JRuby tests pass*)
* `rake release` (*tag the release and upload the `-java` platform gem*)
* `rvm use ruby@rubygems` (*switch back to MRI*)
* `gem build hermann.gemspec` (*build the 'ruby' platform gem*)
* `gem push pkg/hermann-0.blah.gem` (*upload the ruby platform gem*)
This can certainly be cleaned up, but this is the process at it is right now