scottk/wlan-cloud-lib-cppkafka
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/wlan-cloud-lib-cppkafka.git synced 2025-11-01 02:57:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Multiple fixes on README.md

Browse Source
This commit is contained in:
Matias Fontanini
2017-04-16 15:41:08 -07:00
parent 6e248e2bb5
commit ebde747e18
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -1,12 +1,11 @@
# cppkafka # cppkafka
--- ---
High level C++ wrapper for _rdkafka_ High level C++ wrapper for _rdkafka_
--- ---
# Features # Features
* _cppkafka_ is a high level C++ wrapper for _rdkafka_, aiming at allowing to use _rdkafka_ in a * _cppkafka_ is a high level C++ wrapper for _rdkafka_, aiming to allow using _rdkafka_ in a
simple, less error prone way. simple, less error prone way.
* _cppkafka_ provides an API to produce messages as well as consuming messages, but the latter is * _cppkafka_ provides an API to produce messages as well as consuming messages, but the latter is
@@ -14,13 +13,16 @@ only supported via the high level consumer API. _cppkafka_ requires **rdkakfa >=
order to use it. Other wrapped functionalities are also provided, like fetching metadata, order to use it. Other wrapped functionalities are also provided, like fetching metadata,
offsets, etc. offsets, etc.
* _cppkafka_ tries to add minimal overhead over _librdkafka_. A very thin wrapper for _librdkafka_
messages is used for consumption so there's virtually no overhead at all.
**Note**: _cppkafka_ is under development so the API might change through time. Once there's an **Note**: _cppkafka_ is under development so the API might change through time. Once there's an
actual release, it should become more stable. actual release, it should become more stable.
# It's simple! # It's simple!
_cppkafka_'s API is simple. For example, this code creates a producer writes a message into some _cppkafka_'s API is simple. For example, this code creates a producer that writes a message
partition: into some partition:
```c++ ```c++
#include <cppkafka/producer.h> #include <cppkafka/producer.h>