Skip to content

Commit 181a992

Browse files
authored
Merge pull request confluentinc#50 from mhowlett/rm
updated readme
2 parents b268a43 + b3d0ad0 commit 181a992

File tree

1 file changed

+33
-12
lines changed

1 file changed

+33
-12
lines changed

README.md

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,28 @@
1-
Confluent's Apache Kafka client for Golang
2-
==========================================
1+
Confluent's Golang Client for Apache Kafka<sup>TM</sup>
2+
=====================================================
3+
4+
**confluent-kafka-go** is Confluent's Golang client for [Apache Kafka](http://kafka.apache.org/) and the
5+
[Confluent Platform](https://www.confluent.io/product/compare/).
6+
7+
Features:
8+
9+
- **High performance** - confluent-kafka-go is a lightweight wrapper around
10+
[librdkafka](https://github.com/edenhill/librdkafka), a finely tuned C
11+
client.
12+
13+
- **Reliability** - There are a lot of details to get right when writing an Apache Kafka
14+
client. We get them right in one place (librdkafka) and leverage this work
15+
across all of our clients (also [confluent-kafka-python](https://github.com/confluentinc/confluent-kafka-python)
16+
and [confluent-kafka-dotnet](https://github.com/confluentinc/confluent-kafka-dotnet)).
17+
18+
- **Supported** - Commercial support is offered by
19+
[Confluent](https://confluent.io/).
20+
21+
- **Future proof** - Confluent, founded by the
22+
creators of Kafka, is building a [streaming platform](https://www.confluent.io/product/compare/)
23+
with Apache Kafka at its core. It's high priority for us that client features keep
24+
pace with core Apache Kafka and components of the [Confluent Platform](https://www.confluent.io/product/compare/).
325

4-
Confluent's Kafka client for Golang wraps the [librdkafka](https://github.com/edenhill/librdkafka) C library, providing
5-
full Kafka protocol support with great performance and reliability.
626

727
The Golang bindings provides a high-level Producer and Consumer with support
828
for the balanced consumer groups of Apache Kafka 0.9 and above.
@@ -12,11 +32,12 @@ See the [API documentation](http://docs.confluent.io/current/clients/confluent-k
1232
**License**: [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0)
1333

1434

15-
API strands
35+
API Strands
1636
===========
37+
1738
There are two main API strands: channel based or function based.
1839

19-
Channel based consumer
40+
Channel Based Consumer
2041
----------------------
2142

2243
Messages, errors and events are posted on the consumer.Events channel
@@ -38,7 +59,7 @@ See [examples/consumer_channel_example](examples/consumer_channel_example)
3859

3960

4061

41-
Function based consumer
62+
Function Based Consumer
4263
-----------------------
4364

4465
Messages, errors and events are polled through the consumer.Poll() function.
@@ -57,7 +78,7 @@ See [examples/consumer_example](examples/consumer_example)
5778

5879

5980

60-
Channel based producer
81+
Channel Based Producer
6182
----------------------
6283

6384
Application writes messages to the producer.ProducerChannel.
@@ -76,7 +97,7 @@ Cons:
7697
See [examples/producer_channel_example](examples/producer_channel_example)
7798

7899

79-
Function based producer
100+
Function Based Producer
80101
-----------------------
81102

82103
Application calls producer.Produce() to produce messages.
@@ -121,7 +142,7 @@ Build
121142
$ go install
122143

123144

124-
Static builds
145+
Static Builds
125146
=============
126147

127148
**NOTE**: Requires pkg-config
@@ -155,7 +176,7 @@ See [kafka/README](kafka/README.md)
155176

156177

157178

158-
Getting started
179+
Getting Started
159180
===============
160181

161182
Installing librdkafka
@@ -182,7 +203,7 @@ Build from source:
182203
sudo make install
183204

184205

185-
Build the Go client
206+
Build the Go Client
186207
-------------------
187208

188209
From the confluent-kafka-go directory which should reside

0 commit comments

Comments
 (0)