Skip to content

Commit

Permalink
Revamped the README
Browse files Browse the repository at this point in the history
  • Loading branch information
edenhill committed Apr 10, 2017
1 parent cf20a09 commit b268a43
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Confluent's Apache Kafka client for Golang
==========================================

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

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


Beta information
================
The Go client is currently in beta and APIs are subject to (minor) change.

API strands
===========
There are two main API strands: channel based or function based.
Expand Down Expand Up @@ -148,7 +144,7 @@ by default but are available in the corresponding `..-dev` or `..-devel`
packages (e.g., libsasl2-dev).

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



Expand All @@ -165,6 +161,20 @@ Getting started
Installing librdkafka
---------------------

Either install librdkafka through your OS/distributions package manager,
or download and build it from source.

For Debian and Ubuntu based distros, install `librdkafka-dev` from the standard
repositories or using [Confluent's Deb repository](http://docs.confluent.io/3.2.0/installation.html#installation-apt).

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).

For MacOS X, install `librdkafka` from Homebrew.

For Windows, see the `librdkafka.redist` NuGet package.

Build from source:

git clone https://github.com/edenhill/librdkafka.git
cd librdkafka
./configure --prefix /usr
Expand Down

0 comments on commit b268a43

Please sign in to comment.