@@ -16,12 +16,9 @@ offsets, etc.
1616* _ cppkafka_ tries to add minimal overhead over _ librdkafka_ . A very thin wrapper for _ librdkafka_
1717messages is used for consumption so there's virtually no overhead at all.
1818
19- ** Note** : _ cppkafka_ is under development so the API might change through time. Once there's an
20- actual release, it should become more stable.
21-
2219# It's simple!
2320
24- _ cppkafka_ 's API is simple. For example, this code creates a producer that writes a message
21+ _ cppkafka_ 's API is simple to use . For example, this code creates a producer that writes a message
2522into some partition:
2623
2724``` c++
@@ -49,7 +46,7 @@ int main() {
4946
5047In order to compile _ cppkafka_ you need:
5148
52- * _ rdkafka >= 0.9.4_
49+ * _ librdkafka >= 0.9.4_
5350* _ CMake_
5451* A compiler with good C++11 support (e.g. gcc >= 4.8). This was tested successfully on
5552_ g++ 4.8.3_ .
@@ -65,6 +62,17 @@ cmake ..
6562make
6663```
6764
65+ If you have installed _ librdkafka_ on a non standard directory, you can use the
66+ ` RDKAFKA_ROOT_DIR ` cmake parameter when configuring the project:
67+
68+ ``` Shell
69+ cmake .. -DRDKAFKA_ROOT_DIR=/some/other/dir
70+ ```
71+
72+ Note that finding _ librdkafka_ will succeed iff there's an _ include_ and _ lib_
73+ directories inside the specified path, including both the _ rdkafka.h_ header
74+ and the _ librdkafka_ library file.
75+
6876# Using
6977
7078If you want to use _ cppkafka_ , you'll need to link your application with:
@@ -77,3 +85,7 @@ If you want to use _cppkafka_, you'll need to link your application with:
7785You can generate the documentation by running ` make docs ` inside the build directory. This requires
7886_ Doxygen_ to be installed. The documentation will be written in html format at
7987` <build-dir>/docs/html/ ` .
88+
89+ Make sure to check the [ wiki] ( https://github.com/mfontanini/cppkafka/wiki ) which includes
90+ some documentation about the project and some of its features.
91+
0 commit comments