From a09866ce3fdf07c968604955eec96ea3ea84bfd5 Mon Sep 17 00:00:00 2001 From: "R. Tyler Croy" Date: Wed, 2 Sep 2015 04:55:41 -0700 Subject: [PATCH] Update the README with some newer formatting --- README.adoc | 28 ++++++++++++++++++++++++++++ README.md | 29 ----------------------------- 2 files changed, 28 insertions(+), 29 deletions(-) create mode 100644 README.adoc delete mode 100644 README.md diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..9a4d200 --- /dev/null +++ b/README.adoc @@ -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 diff --git a/README.md b/README.md deleted file mode 100644 index 23d7d95..0000000 --- a/README.md +++ /dev/null @@ -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