Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Update documentation with Rails 3 information

  • Loading branch information...
commit 7d000a54441ff1d8ae6adb39bc0828ab3d4e74e3 1 parent 4d0b22f
Musy Bite authored

Showing 1 changed file with 19 additions and 4 deletions. Show diff stats Hide diff stats

  1. +19 4 README.rdoc
23 README.rdoc
Source Rendered
@@ -30,15 +30,27 @@ to store the flags, which should be defined to not allow NULL values and
30 30 should have a default value of 0 (which means all flags are initially set to
31 31 false).
32 32
33   -The plugin has been tested with Rails versions from 2.1 to 2.3 and MySQL,
34   -PostgreSQL and SQLite3 databases.
  33 +The plugin has been tested with Rails versions from 2.1 to 3.0 and MySQL,
  34 +PostgreSQL and SQLite3 databases. It has been tested with ruby 1.9.2 (with
  35 +Rails 3 only).
35 36
36 37
37 38 ==Installation
38 39
  40 +===As plugin (Rails 2.x, Rails 3)
  41 +
39 42 cd path/to/your/rails-project
40 43 ./script/plugin install git://github.com/xing/flag_shih_tzu.git
41 44
  45 +===As gem (Rails 3)
  46 +
  47 +Add following line to your Gemfile:
  48 +
  49 + gem 'flag_shih_tzu', '= 0.1.0.pre'
  50 +
  51 +Make sure to install gem with bundler:
  52 +
  53 + bundle install
42 54
43 55 ==Usage
44 56
@@ -220,6 +232,8 @@ on the flags column.
220 232
221 233 ==Running the plugin tests
222 234
  235 +1. (Rails 3 only) Add <tt>mysql2</tt>, <tt>pg</tt> and <tt>sqlite3</tt> gems to your Gemfile.
  236 +1. Install flag_shih_tzu as plugin inside working Rails application.
223 237 1. Modify <tt>test/database.yml</tt> to fit your test environment.
224 238 2. If needed, create the test database you configured in <tt>test/database.yml</tt>.
225 239
@@ -253,8 +267,9 @@ Please find out more about our work in our
253 267 {Peter Boling}[http://github.com/pboling],
254 268 {Daniel Jagszent}[http://github.com/d--j],
255 269 {Thorsten Boettger}[http://github.com/alto],
256   -{Darren Torpey}[http://github.com/darrentorpey] and
257   -{Joost Baaij}[http://github.com/tilsammans]
  270 +{Darren Torpey}[http://github.com/darrentorpey],
  271 +{Joost Baaij}[http://github.com/tilsammans] and
  272 +{Musy Bite}[http://github.com/musybite]
258 273
259 274
260 275 ==License

0 comments on commit 7d000a5

Please sign in to comment.
Something went wrong with that request. Please try again.