Skip to content

Installation prerequisite documentation #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Installation prerequisite documentation #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,23 @@ This project is released under the Apache License Version 2.0 (APLv2).
- update the version number in `lib/kafkat/version.rb`
- execute `bundle exec rake release`

## Installation

## Usage
* Make sure Ruby is installed and that you can build native extensions.

For instance on Ubuntu 16.04:
```
sudo apt-get install ruby2.3 ruby2.3-dev build-essential
```

* Install the gem.

```
gem install kafkat
```

## Usage

* Create a new configuration file to match your deployment.

```
Expand Down