README.md in simple_form-3.0.0.beta1 vs README.md in simple_form-3.0.0.rc
- old
+ new
@@ -1,19 +1,23 @@
-# SimpleForm - Rails forms made easy.
-[](http://travis-ci.org/plataformatec/simple_form)
+
+By [Plataformatec](http://plataformatec.com.br/).
+
+[](http://badge.fury.io/rb/simple_form)
+[](http://travis-ci.org/plataformatec/simple_form)
+[](https://codeclimate.com/github/plataformatec/simple_form)
+
+Rails forms made easy.
+
**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:
+and refers to **SimpleForm** 3.0. 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:
```ruby
@@ -39,11 +43,11 @@
gem 'country_select'
```
### Twitter Bootstrap
-**SimpleForm** 2.0 can be easily integrated to the [Twitter Bootstrap](http://twitter.github.com/bootstrap).
+**SimpleForm** 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:
```console
rails generate simple_form:install --bootstrap
```
@@ -65,11 +69,11 @@
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).
+Please see the [instructions on how to install Foundation in a Rails app](http://foundation.zurb.com/old-docs/f3/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
@@ -807,11 +811,11 @@
end
```
**SimpleForm** also allows you to use optional elements. For instance, let's suppose you want to use
hints or placeholders, but you don't want them to be generated automatically. You can set their
-default values to `false` or use the `optional` method. Is preferible to use the `optional` syntax:
+default values to `false` or use the `optional` method. Is preferable to use the `optional` syntax:
```ruby
config.wrappers placeholder: false do |b|
b.use :placeholder
b.use :label_input
@@ -821,11 +825,11 @@
end
end
```
By setting it as `optional`, a hint will only be generated when `hint: true` is explicitly used.
-The same for placehold.
+The same for placeholder.
## HTML 5 Notice
By default, **SimpleForm** will generate input field types and attributes that are supported in HTML5,
but are considered invalid HTML for older document types such as HTML4 or XHTML1.0. The HTML5
@@ -900,5 +904,7 @@
* Vasiliy Ermolovich (https://github.com/nashby)
## License
MIT License. Copyright 2009-2013 Plataformatec. http://plataformatec.com.br
+
+You are not granted rights or licenses to the trademarks of the Plataformatec, including without limitation the Simple Form name or logo.