Update the README with badges and asciidoc

This commit is contained in:
R. Tyler Croy 2015-09-11 11:06:40 -07:00
parent e9ef36155d
commit c4ba598c82
No known key found for this signature in database
GPG Key ID: 1426C7DC3F51E16F
2 changed files with 40 additions and 32 deletions

40
README.adoc Normal file
View File

@ -0,0 +1,40 @@
= RedStorm - JRuby on Storm
image:https://travis-ci.org/jruby-gradle/redstorm.svg?branch=master["Build
Status", link="https://travis-ci.org/jruby-gradle/redstorm"]
image::https://api.bintray.com/packages/jruby-gradle/libraries/redstorm/images/download.svg[link="https://bintray.com/jruby-gradle/libraries/redstorm/_latestVersion"]
RedStorm provides a Ruby DSL using JRuby integration for the
link:http://storm.apache.org[Apache Storm] distributed realtime computation
system.
Like RedStorm? visit us on IRC at `#redstorm` on
link:http://freenode.net[Freenode]
== Documentation
Chances are new versions of RedStorm will introduce changes that will break
compatibility or change the developement workflow. To prevent out-of-sync
documentation, per version specific documentation are kept
link:https://github.com/jruby-gradle/redstorm/wiki[in the wiki] when necessary.
== Authors
* **Colin Surprenant**, http://github.com/colinsurprenant/,
link:https://twitter.com/colinsurprenant/[@colinsurprenant], colin.surprenant@gmail.com, http://colinsurprenant.com/
* **R Tyler Croy**, http://github.com/rtyler/,
link:https://twitter.com/agentdero/[@agentdero]
== Contributors
* Theo Hultberg, https://github.com/iconara
* Paul Bergeron, https://github.com/dinedal
* Phil Pirozhkov, https://github.com/pirj
* Evan Broderm, https://github.com/ebroder
* Shay Elkin, https://github.com/shayel
* adsummos, https://github.com/adsummos
== License
Apache License, Version 2.0. See the LICENSE.md file.

View File

@ -1,32 +0,0 @@
# RedStorm - JRuby on Storm
RedStorm provides a Ruby DSL using JRuby integration for the
[Storm](https://github.com/apache/storm/) distributed realtime computation
system.
Like RedStorm? visit us on IRC at #redstorm on freenode
## Documentation
Chances are new versions of RedStorm will introduce changes that will break
compatibility or change the developement workflow. To prevent out-of-sync
documentation, per version specific documentation are kept [in the
wiki](https://github.com/jruby-gradle/redstorm/wiki) when necessary.
## Author
* **Colin Surprenant**, http://github.com/colinsurprenant/, [@colinsurprenant](http://twitter.com/colinsurprenant/), colin.surprenant@gmail.com, http://colinsurprenant.com/
* **R Tyler Croy**, http://github.com/rtyler/, [@agentdero](http://twitter.com/agentdero/)
## Contributors
* Theo Hultberg, https://github.com/iconara
* Paul Bergeron, https://github.com/dinedal
* Phil Pirozhkov, https://github.com/pirj
* Evan Broderm, https://github.com/ebroder
* Shay Elkin, https://github.com/shayel
* adsummos, https://github.com/adsummos
## License
Apache License, Version 2.0. See the LICENSE.md file.