reiseburo
/
offtopic
mirror of https://github.com/reiseburo/offtopic
1
0
Fork 0
Code Issues Releases Wiki Activity

Update the README with some newer formatting

This commit is contained in:
R. Tyler Croy 2015-09-02 04:55:41 -07:00
parent c537512616
commit a09866ce3f
No known key found for this signature in database
GPG Key ID: 1426C7DC3F51E16F
2 changed files with 28 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.adoc Normal file
View File

@ -0,0 +1,28 @@
= Offtopic
image:https://travis-ci.org/rtyler/offtopic.svg?branch=master["Build Status", link="https://travis-ci.org/rtyler/offtopic"]
image:https://api.bintray.com/packages/rtyler/maven/offtopic/images/download.svg[link="https://bintray.com/rtyler/maven/offtopic/_latestVersion"]
Offtopic is a simple web application built with link:http://ratpack.io[Ratpack]
for inspecting and consuming events from link:http://kafka.apache.org[Apache Kafka]
The primary goal of this tool is to give you real-time insight into a running
Kafka cluster.
image:http://strongspace.com/rtyler/public/offtopic-secevents-20141125.png['Watching topics in action']
== System Requirements
* Java 8
* link:http://zookeeper.apache.org[Apache Zookeeper]
* link:http://kafka.apache.org[Apache 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 (link:http://strongspace.com/rtyler/public/offtopic-usemultipass-20141125.png[screenshot of multipass in action])
* **Binary data support**: Clicking on a message row in the "watch" view will
drop down a base64-encoded version of the message data

29
README.md
View File

@ -1,29 +0,0 @@
# Offtopic
[![Build Status](https://travis-ci.org/rtyler/offtopic.svg?branch=master)](https://travis-ci.org/rtyler/offtopic)
[ ![Download](https://api.bintray.com/packages/rtyler/maven/offtopic/images/download.svg) ](https://bintray.com/rtyler/maven/offtopic/_latestVersion)
Offtopic is a simple web application built with [Ratpack](http://ratpack.io)
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
)
## 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 ([screenshot of multipass in action](http://strongspace.com/rtyler/public/offtopic-usemultipass-20141125.png))
* **Binary data support**: Clicking on a message row in the "watch" view will
drop down a base64-encoded version of the message data