Add some requirements and features to the readme

This commit is contained in:
R. Tyler Croy 2014-11-25 13:09:34 -08:00
parent 5b1574097d
commit 18ef7b8219
2 changed files with 17 additions and 1 deletions

View File

@ -6,5 +6,20 @@ for inspecting and consuming events from [Kafka](http://kafka.apache.org).
The primary goal of this tool is to give you real-time insight into a running
Kafka cluster.
![Watching topics in action](http://strongspace.com/rtyler/public/offtopic-secevents-20141125.png
)
![Watching topics in action](http://strongspace.com/rtyler/public/offtopic-watching-topics-20141123.png)
## Requirements
* Java 8
* Zookeeper
* Kafka
## Features
* **Watch**: From the `/topics` page clicking the "watch" button will set up a
WebSockets-based stream of events straight from Kafka to your browser
* **Multipass**: From the `/topics` page you can select multiple topics to
watch at once
* **Binary data support**: Clicking on a message row in the "watch" view will
drop down a base64-encoded version of the message data

View File

@ -12,6 +12,7 @@ version = '0.1.0'
group = 'offtopic'
description =' Offtopic is a simple web application built with Ratpack for inspecting and consuming events from Kafka.'
sourceCompatibility = '1.7'
targetCompatibility = '1.7'
////////////////////////////////////////////////////////////////////////////////