README.md in simple_form-2.0.4 vs README.md in simple_form-2.1.0
- old
+ new
@@ -1,54 +1,72 @@
# SimpleForm - Rails forms made easy.
-[](http://travis-ci.org/plataformatec/simple_form)
+[](http://travis-ci.org/plataformatec/simple_form)
**SimpleForm** aims to be as flexible as possible while helping you with powerful components to create
your forms. The basic goal of SimpleForm is to not touch your way of defining the layout, letting
you find the better design for your eyes. Most of the DSL was inherited from Formtastic,
which we are thankful for and should make you feel right at home.
-INFO: This README is [also available in a friendly navigable format](http://simple-form.plataformatec.com.br/)
-and refers to **SimpleForm** 2.0. If you are using **SimpleForm** in the versions 1.x, you should
-check this branch:
+INFO: This README refers to **SimpleForm** 2.1. For older releases, check the related branch for your version.
-https://github.com/plataformatec/simple_form/tree/v1.5
-
## Installation
Add it to your Gemfile:
-`gem 'simple_form'`
+```ruby
+gem 'simple_form'
+```
Run the following command to install it:
-`bundle install`
+```console
+bundle install
+```
Run the generator:
-`rails generate simple_form:install`
+```console
+rails generate simple_form:install
+```
Also, if you want to use the country select, you will need the
[country_select gem](https://rubygems.org/gems/country_select), add it to your Gemfile:
-`gem 'country_select'`
+```ruby
+gem 'country_select'
+```
### Twitter Bootstrap
**SimpleForm** 2.0 can be easily integrated to the [Twitter Bootstrap](http://twitter.github.com/bootstrap).
To do that you have to use the `bootstrap` option in the install generator, like this:
-`rails generate simple_form:install --bootstrap`
+```console
+rails generate simple_form:install --bootstrap
+```
You have to be sure that you added a copy of the [Twitter Bootstrap](http://twitter.github.com/bootstrap)
assets on your application.
For more information see the generator output, our
[example application code](https://github.com/rafaelfranca/simple_form-bootstrap) and
[the live example app](http://simple-form-bootstrap.plataformatec.com.br/).
**NOTE**: **SimpleForm** integration requires Twitter Bootstrap version 2.0 or higher.
+### Zurb Foundation 3
+
+To generate wrappers that are compatible with [Zurb Foundation 3](http://foundation.zurb.com/), pass the `foundation` option to the generator, like this:
+
+```console
+rails generate simple_form:install --foundation
+```
+
+Please note that the Foundation wrapper does not support the `:hint` option by default. In order to enable hints, please uncomment the appropriate line in `config/initializers/simple_form_foundation.rb`. You will need to provide your own CSS styles for hints.
+
+Please see the [instructions on how to install Foundation in a Rails app](http://foundation.zurb.com/docs/rails.php).
+
## Usage
**SimpleForm** was designed to be customized as you need to. Basically it's a stack of components that
are invoked to create a complete html input for you, which by default contains label, hints, errors
and the input itself. It does not aim to create a lot of different logic from the default Rails
@@ -855,6 +873,6 @@
* Rafael Mendonça França (https://github.com/rafaelfranca)
* Vasiliy Ermolovich (https://github.com/nashby)
## License
-MIT License. Copyright 2012 Plataformatec. http://plataformatec.com.br
+MIT License. Copyright 2009-2013 Plataformatec. http://plataformatec.com.br