README.md in dionysus-1.0.2 vs README.md in dionysus-2.0.0

- old
+ new

@@ -1,59 +1,56 @@ -Dionysus -======== +# Dionysus -A helpful set of utility classes, generators, and command-line tools. +<<< description.md > Dionysus or Dionysos (pronounced /ˌdaɪ.ɵˈnaɪsəs/; Greek: Διόνυσος or > Διώνυσος) is the ancient Greek god of wine, the inspirer of ritual madness > and ecstasy, and a major figure of Greek mythology. > [Wikipedia: Dionysus (2010/03/15)](http://en.wikipedia.org/wiki/Dionysus) -Requirements ------------- +**GitHub** http://github.com/tekwiz/dionysus -* Rails 3 +**Issues** http://github.com/tekwiz/dionysus/issues -Installation ------------- +**Travis-CI** http://travis-ci.org/tekwiz/dionysus +[![Build Status](https://secure.travis-ci.org/tekwiz/dionysus.png?branch=master)](http://travis-ci.org/tekwiz/dionysus) - gem install dionysus +**Docs** http://rubydoc.info/gems/dionysus -Usage ------ +**RubyGems** http://rubygems.org/gems/dionysus -First, add "dionysus" to your Gemfile or whatever other dependency system you're using. Then, you'll need to require each file/module as you need them. Dionysus is setup *à la carte* since parts are bound to conflict with something you're using at some point. +## Requirements -Resources ---------- +* ActiveSupport 3.1 or 3.2 -* [Github Project](http://github.com/tekwiz/dionysus) -* [SDocs](http://tekwiz.github.com/dionysus) -* [Wiki on Github](http://wiki.github.com/tekwiz/dionysus/) -* [Issues Tracker on Github](http://github.com/tekwiz/dionysus/issues) +##Installation -Features & Issues ------------------ + $ gem install dionysus -This is a brand new project, so if you find bugs or use cases that would helpful to satisfy, post an [Issue](http://github.com/tekwiz/dionysus/issues) on Github. +or add to your Gemfile: -This project is intended to be a **very** eclectic mix of helpful tools, so please feel free to send pull requests. That said, make **absolutely sure** your modifications are well tested. The hodge-podge nature of this project may make it prone to issues, so no code will be pulled-in that is not __fully_tested__. + gem "dionysus" -Note on Patches/Pull Requests ------------------------------ +and -* Fork the project. -* Make your feature addition or bug fix. -* Add tests for it. This is important so I don't break it in a - future version unintentionally. -* Commit, do not mess with rakefile, version, or history. - (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) -* Send me a pull request. Bonus points for topic branches. + $ bundle install -Copyright ---------- +## Usage - Copyright 2010 Travis D. Warlick, Jr. +Add dionysus to your Gemfile: + + gem "dionysus" + +Then, you'll need to require each file/module as you need them. Dionysus is setup *à la carte* +since parts are bound to conflict with something you're using at some point. + +## Contributing + +This project is intended to be a **very** eclectic mix of helpful tools, so please feel free to send pull requests. That said, make **absolutely sure** your modifications are well tested. The hodge-podge nature of this project may make it prone to issues, so no code will be pulled-in that is not __fully_tested__. + +----------------------------- + + Copyright 2012 Travis D. Warlick, Jr. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at