Skip to content

Commit 7e2ffdd

Browse files
authored
Clarify dependencies
1 parent 9a421ab commit 7e2ffdd

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,26 @@ import SwiftKafka
5151

5252
## Getting Started
5353

54-
To run the library you need a Kafka server to produce/consume from.
54+
To use SwiftKafka you will need to install the `librdkafka` package:
55+
56+
### macOS
57+
```
58+
brew install librdkafka
59+
```
60+
61+
### Linux
62+
Install librdkafka from the Confluent APT repositories - [see instructions here](https://docs.confluent.io/current/installation/installing_cp/deb-ubuntu.html#get-the-software) (following steps 1 and 2 to add the Confluent package signing key and apt repository), and then install librdkafka:
63+
```
64+
sudo apt install librdkafka
65+
```
66+
67+
#### Running a Kafka instance locally
68+
To experiment locally, you can set up your own Kafka server to produce/consume from.
5569

5670
On macOS you can follow this guide on [Kafka Installation using Homebrew](https://medium.com/@Ankitthakur/apache-kafka-installation-on-mac-using-homebrew-a367cdefd273) to run a local server.
5771

72+
On Linux, you can follow this guide for [a manual install on Ubuntu](https://docs.confluent.io/current/installation/installing_cp/deb-ubuntu.html).
73+
5874
### KafkaConfig
5975

6076
The `KafkaConfig` class contains your configuration settings for a `KafkaConsumer`/`KafkaProducer`.

0 commit comments

Comments
 (0)