You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-1
Original file line number
Diff line number
Diff line change
@@ -51,10 +51,26 @@ import SwiftKafka
51
51
52
52
## Getting Started
53
53
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.
55
69
56
70
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.
57
71
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
+
58
74
### KafkaConfig
59
75
60
76
The `KafkaConfig` class contains your configuration settings for a `KafkaConsumer`/`KafkaProducer`.
0 commit comments