mirror of https://github.com/reiseburo/hermann
Moved license to LICENSE.md and reformatted markdown. Closes #1
This commit is contained in:
parent
8b056ed861
commit
5af39f06ba
|
@ -0,0 +1,21 @@
|
||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2014 Lookout, Inc.
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in
|
||||||
|
all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
|
THE SOFTWARE.
|
35
README.md
35
README.md
|
@ -2,13 +2,16 @@
|
||||||
|
|
||||||
A Ruby gem implementing a Kafka Publisher and Consumer
|
A Ruby gem implementing a Kafka Publisher and Consumer
|
||||||
|
|
||||||
This library wraps the [librdkafka library](https://github.com/edenhill/librdkafka) which is implemented in C.
|
This library wraps the
|
||||||
This library must be installed before we can use the Hermann gem.
|
[librdkafka library](https://github.com/edenhill/librdkafka) which is
|
||||||
|
implemented in C. This library must be installed before we can use
|
||||||
|
the Hermann gem.
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
Usage is modelled on the kafka-rb gem
|
Usage is modelled on the
|
||||||
(https://github.com/acrosa/kafka-rb) and is fairly straightforward.
|
[kafka-rb gem](https://github.com/acrosa/kafka-rb) and is fairly
|
||||||
|
straightforward.
|
||||||
|
|
||||||
- Kafka 0.8 is supported.
|
- Kafka 0.8 is supported.
|
||||||
- Ruby 1.8.7 and Ruby 2.1.1 have been tested, but JRuby and versions
|
- Ruby 1.8.7 and Ruby 2.1.1 have been tested, but JRuby and versions
|
||||||
|
@ -53,27 +56,3 @@ yet coordinate partition (re)assigment within consumer groups.
|
||||||
## Questions?
|
## Questions?
|
||||||
|
|
||||||
Stan Campbell can be reached at stan.campbell3 at( @ ) gmail.com
|
Stan Campbell can be reached at stan.campbell3 at( @ ) gmail.com
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2014 Lookout, Inc.
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in
|
|
||||||
all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
||||||
THE SOFTWARE.
|
|
||||||
|
|
Loading…
Reference in New Issue