http://coryschires-blog-post-images.s3.amazonaws.com/rostra.png

Rostra allows you to quickly add a question and answer forum to your application. Requires Rails 3.1 and Ruby 1.9.2.

<b>NOTE: Rostra is not production ready.</b>

== Installation
Include the gem to your <tt>Gemfile</tt>:

  gem 'rostra'

Mount the engine in <tt>config/routes.rb</tt>:

  mount Rostra::Engine => "/rostra"   # or whatever path you like

Install and run the necessary migrations:

  rake rostra:install:migrations
  rake db:migrate

Run the generator to create the configuration file:

  rails generate rostra:install   # see `config/initializers/rostra.rb` for details

Call <tt>rostra</tt> in your user model:

  class User < ActiveRecord::Base
    rostra
  end


== Customizing the question and answer models
Rostra provides a DSL for adding application specific logic to <tt>Rostra::Question</tt> and <tt>Rostra:Answer</tt>:

  class User < ActiveRecord::Base
    rostra do
      questions do
        # Code inside this block will be evaluated in the context of `Rostra::Question`.

        # So an instance method might look like:
        #
        def active?
          # call this like @question.active?
        end
      end

      answers do
        # Code inside this block will be evaluated in the context of `Rostra::Answer`

        # So a class method might look like:
        #
        def self.recently_up_voted
          # call this like Rostra::Answer.recently_up_voted
        end
      end

    end
  end


== Contributing to Rostra
Fork the project, make your changes, and submit a pull request. Please ensure the tests pass:

  rspec spec         # runs the specs
  cucumber features  # runs the cukes

<b>Contributors:</b> {robertwalsh0}[https://github.com/robertwalsh0], {bcody}[https://github.com/bcody]

== License
This project uses MIT-LICENSE.