Skip to content

Commit

Permalink
added requirements and installation process to the README file and ro…
Browse files Browse the repository at this point in the history
…ckspec for master branch
  • Loading branch information
and.sergeev committed Feb 1, 2019
1 parent 0671644 commit fd93acd
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@ tnt-kafka
=========
Full featured high performance kafka library for Tarantool based on [librdkafka](https://github.com/edenhill/librdkafka).

Can produce more then 80k messages per second and consume more then 130k messages per second.

Library was tested with librdkafka v0.11.5
Can produce more then 150k messages per second and consume more then 140k messages per second.

# Features
* Kafka producer and consumer implementations.
Expand All @@ -13,6 +11,20 @@ Library was tested with librdkafka v0.11.5
some libraries throws lua native `error` while others throws `box.error` instead. `tnt-kafka` returns
non critical errors as strings which allows you to decide how to handle it.

# Requirements
* Tarantool >= 1.10.2
* Tarantool development headers
* librdkafka >= 0.11.5
* librdkafka development headers
* make
* cmake
* gcc

# Installation
```bash
tarantoolctl rocks install https://raw.githubusercontent.com/tarantool/tnt-kafka/master/rockspecs/tnt-kafka-scm-1.rockspec
```

# Examples

## Consumer
Expand Down
31 changes: 31 additions & 0 deletions rockspecs/tnt-kafka-scm-1.rockspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package = "tnt-kafka"
version = "scm-1"
source = {
url = "git://github.com/tarantool/tnt-kafka.git",
branch = 'master',
}
description = {
summary = "Kafka library for Tarantool",
homepage = "https://github.com/tarantool/tnt-kafka",
license = "Apache",
}
dependencies = {
"lua >= 5.1" -- actually tarantool > 1.6
}
external_dependencies = {
TARANTOOL = {
header = 'tarantool/module.h'
},
RDKAFKA = {
header = 'librdkafka/rdkafka.h'
}
}
build = {
type = 'cmake';
variables = {
CMAKE_BUILD_TYPE="RelWithDebInfo",
TARANTOOL_DIR="$(TARANTOOL_DIR)",
TARANTOOL_INSTALL_LIBDIR="$(LIBDIR)",
TARANTOOL_INSTALL_LUADIR="$(LUADIR)"
}
}

0 comments on commit fd93acd

Please sign in to comment.