Skip to content

Commit cac2bbd

Browse files
mensfeldpboling
andauthored
Run README through Grammarly, rename LICENSE to MIT-LICENSE (karafka#326)
* Run readme through Grammarly, rename LICENSE to MIT-LICENSE * Update README.md Co-authored-by: Peter Boling <[email protected]> * fix invalid date --------- Co-authored-by: Peter Boling <[email protected]>
1 parent 89fcd3d commit cac2bbd

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

LICENSE MIT-LICENSE

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2017 Thijs Cadier
3+
Copyright (c) 2017-2023 Thijs Cadier
4+
2023, Maciej Mensfeld
45

56
Permission is hereby granted, free of charge, to any person obtaining a copy
67
of this software and associated documentation files (the "Software"), to deal

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@
1212
The `rdkafka` gem is a modern Kafka client library for Ruby based on
1313
[librdkafka](https://github.com/edenhill/librdkafka/).
1414
It wraps the production-ready C client using the [ffi](https://github.com/ffi/ffi)
15-
gem and targets Kafka 1.0+ and Ruby versions that are under security or
16-
active maintenance. We remove Ruby version from our CI builds if they
15+
gem and targets Kafka 1.0+ and Ruby versions under security or
16+
active maintenance. We remove a Ruby version from our CI builds when they
1717
become EOL.
1818

1919
`rdkafka` was written because of the need for a reliable Ruby client for Kafka that supports modern Kafka at [AppSignal](https://appsignal.com). AppSignal runs it in production on very high-traffic systems.
2020

2121
The most important pieces of a Kafka client are implemented. We're
22-
working towards feature completeness, you can track that here:
22+
working towards feature completeness. You can track that here:
2323
https://github.com/appsignal/rdkafka-ruby/milestone/1
2424

2525
## Table of content
@@ -38,7 +38,7 @@ https://github.com/appsignal/rdkafka-ruby/milestone/1
3838
## Installation
3939

4040
This gem downloads and compiles librdkafka when it is installed. If you
41-
have any problems installing the gem please open an issue.
41+
If you have any problems installing the gem, please open an issue.
4242

4343
## Usage
4444

@@ -64,9 +64,9 @@ end
6464

6565
### Producing messages
6666

67-
Produce a number of messages, put the delivery handles in an array and
67+
Produce a number of messages, put the delivery handles in an array, and
6868
wait for them before exiting. This way the messages will be batched and
69-
sent to Kafka in an efficient way.
69+
efficiently sent to Kafka.
7070

7171
```ruby
7272
config = {:"bootstrap.servers" => "localhost:9092"}
@@ -91,7 +91,7 @@ released until it `#close` is explicitly called, so be sure to call
9191

9292
## Higher level libraries
9393

94-
Currently, there are two actively developed frameworks based on rdkafka-ruby, that provide higher level API that can be used to work with Kafka messages and one library for publishing messages.
94+
Currently, there are two actively developed frameworks based on rdkafka-ruby, that provide higher-level API that can be used to work with Kafka messages and one library for publishing messages.
9595

9696
### Message processing frameworks
9797

@@ -104,7 +104,7 @@ Currently, there are two actively developed frameworks based on rdkafka-ruby, th
104104

105105
## Development
106106

107-
A Docker Compose file is included to run Kafka and Zookeeper. To run
107+
A Docker Compose file is included to run Kafka. To run
108108
that:
109109

110110
```
@@ -122,7 +122,7 @@ DEBUG_PRODUCER=true bundle exec rspec
122122
DEBUG_CONSUMER=true bundle exec rspec
123123
```
124124

125-
After running the tests you can bring the cluster down to start with a
125+
After running the tests, you can bring the cluster down to start with a
126126
clean slate:
127127

128128
```
@@ -131,7 +131,7 @@ docker-compose down
131131

132132
## Example
133133

134-
To see everything working run these in separate tabs:
134+
To see everything working, run these in separate tabs:
135135

136136
```
137137
bundle exec rake consume_messages

0 commit comments

Comments
 (0)