questiongenerator/README.md

40 lines
1011 B
Markdown
Raw Normal View History

2014-12-08 15:59:33 -08:00
# questiongenerator
A simple question generator, used by justask.
## Installation
Add this line to your application's Gemfile:
gem 'questiongenerator'
If you're feeling _edgy_, you can add this line instead:
gem 'questiongenerator', git: 'https://github.com/justask/questiongenerator.git'
## Usage
``` ruby
require 'questiongenerator'
# Configure it
QuestionGenerator.question_base_path = '/home/nilsding/questions'
QuestionGenerator.default_locale = :en
# Get some questions
puts QuestionGenerator.generate
# => "What is the best thing about the internet?"
# You can also specify the locale, if you want to
puts QuestionGenerator.generate :de
# => "Was war das letzte, das du gegessen hast?"
```
## Contributing
1. Fork it ( https://github.com/justask/questiongenerator/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request