Skip to content

Commit

Permalink
modified readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ben authored and ben committed Jul 6, 2011
1 parent 9cfb23d commit 516334c
Showing 1 changed file with 23 additions and 10 deletions.
33 changes: 23 additions & 10 deletions clients/cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,41 +2,54 @@
This library allows you to produce messages to the Kafka distributed publish/subscribe messaging service.

## Requirements
Tested on Linux with g++ 4.4 and Boost 1.46.1
Tested on Ubuntu and Redhat both with g++ 4.4 and Boost 1.46.1

## Installation
Make sure you have g++ and the latest version of Boost:
http://gcc.gnu.org/
http://www.boost.org/

```bash
make producer
./configure
```

for the producer example,
Run this to generate the makefile for your system. Do this first.


```bash
make
```

builds the producer example and the KafkaConnect library


```bash
make tests
make check
```

for tests,
builds and runs the unit tests,


```bash
make all
make install
```

for both.
to install as a shared library to 'default' locations (/usr/local/lib and /usr/local/include on linux)


## Usage
The tests directory contains a Kafka Producer example.
Example.cpp is a very basic Kafka Producer

## API docs

have a look at the header file: /src/producer.hpp
## API docs
There isn't much code, if I get around to writing the other parts of the library I'll document it sensibly,
for now have a look at the header file: /src/producer.hpp


## Contact for questions

Ben Gray, MediaSift Ltd.

http://twitter.com/benjamg


0 comments on commit 516334c

Please sign in to comment.