Add a simple README for now

This commit is contained in:
R. Tyler Croy 2015-09-02 11:52:08 -07:00
parent 3f6601b18c
commit a42c0fa3dd
No known key found for this signature in database
GPG Key ID: 1426C7DC3F51E16F
1 changed files with 20 additions and 0 deletions

20
README.adoc Normal file
View File

@ -0,0 +1,20 @@
= Beetle
Beetle is a somewhat higher level Java API on top of the client libraries
distributed distributed with link:http://kafka.apache.org[Apache Kafka]. The
goal of this library is not to replace the use of those libraries, but to wrap
the library in a more easy to use package.
== System Requirements
* JDK7 or later
== Hacking
This project uses link:http://gradle.org[Gradle] so building and testing should
be as easy as executing:
% ./gradlew