Skip to content

Commit c58a479

Browse files
authored
Update README.md
1 parent d88e2d9 commit c58a479

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,9 @@ offsets, etc.
1616
* _cppkafka_ tries to add minimal overhead over _librdkafka_. A very thin wrapper for _librdkafka_
1717
messages 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
2522
into some partition:
2623

2724
```c++
@@ -49,7 +46,7 @@ int main() {
4946

5047
In 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 ..
6562
make
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

7078
If 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:
7785
You 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

Comments
 (0)