Skip to content

Commit b268a43

Browse files
authored
Revamped the README
1 parent cf20a09 commit b268a43

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Confluent's Apache Kafka client for Golang
22
==========================================
33

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

77
The Golang bindings provides a high-level Producer and Consumer with support
@@ -12,10 +12,6 @@ See the [API documentation](http://docs.confluent.io/current/clients/confluent-k
1212
**License**: [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0)
1313

1414

15-
Beta information
16-
================
17-
The Go client is currently in beta and APIs are subject to (minor) change.
18-
1915
API strands
2016
===========
2117
There are two main API strands: channel based or function based.
@@ -148,7 +144,7 @@ by default but are available in the corresponding `..-dev` or `..-devel`
148144
packages (e.g., libsasl2-dev).
149145

150146
After a succesful static build verify the dependencies by running
151-
`ldd ./your_program`, librdkafka should not be listed.
147+
`ldd ./your_program` (or `otool -L ./your_program` on OSX), librdkafka should not be listed.
152148

153149

154150

@@ -165,6 +161,20 @@ Getting started
165161
Installing librdkafka
166162
---------------------
167163

164+
Either install librdkafka through your OS/distributions package manager,
165+
or download and build it from source.
166+
167+
For Debian and Ubuntu based distros, install `librdkafka-dev` from the standard
168+
repositories or using [Confluent's Deb repository](http://docs.confluent.io/3.2.0/installation.html#installation-apt).
169+
170+
For Redhat based distros, install `librdkafka-devel` using [Confluent's YUM repository](http://docs.confluent.io/3.2.0/installation.html#rpm-packages-via-yum).
171+
172+
For MacOS X, install `librdkafka` from Homebrew.
173+
174+
For Windows, see the `librdkafka.redist` NuGet package.
175+
176+
Build from source:
177+
168178
git clone https://github.com/edenhill/librdkafka.git
169179
cd librdkafka
170180
./configure --prefix /usr

0 commit comments

Comments
 (0)