Skip to content

Commit 98989aa

Browse files
committed
Update README
1 parent 0aa52e3 commit 98989aa

File tree

1 file changed

+45
-49
lines changed

1 file changed

+45
-49
lines changed

README.markdown

Lines changed: 45 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,11 @@
22

33
[![Build Status](http://travis-ci.org/bcardarella/client_side_validations.png)](http://travis-ci.org/bcardarella/client_side_validations)
44

5-
Client Side Validations made easy for your Rails applications!
5+
`ClientSideValidations` made easy for your Rails applications!
66

77
In addition to this README please checkout the [wiki](https://github.com/bcardarella/client_side_validations/wiki) and
88
[ClientSideValidations GoogleGroup](http://groups.google.com/group/client_side_validations).
99

10-
This repository is for Rails 3. For Rails 2 compatibility, try [Rails 2 ClientSideValidations](https://github.com/bcardarella/client_side_validations-rails_2).
11-
1210
## Project Goals ##
1311

1412
1. Follow the best practices for client side validations developed by [Luke Wroblewski](http://www.alistapart.com/articles/inline-validation-in-web-forms/)
@@ -28,67 +26,33 @@ This repository is for Rails 3. For Rails 2 compatibility, try [Rails 2 ClientSi
2826

2927
## Install ##
3028

31-
Include Client Side Validations in your Gemfile
29+
Include `ClientSideValidations` in your Gemfile
3230

3331
```ruby
3432
gem 'client_side_validations'
3533
```
3634

3735
Then run the install generator
3836

39-
rails g client_side_validations:install
40-
41-
This will install two files:
42-
43-
config/initializers/client_side_validations.rb
44-
public/javascripts/rails.validations.js
45-
46-
## Upgrading ##
47-
48-
### Rails 3.1 ###
49-
Because the javascript file is now in the asset pipeline there is no
50-
need to rerun the generator after upgrading.
51-
52-
### Rails 3.0 ###
53-
Always be sure to run
37+
```
38+
rails g client_side_validations:install
39+
```
5440

55-
rails g client_side_validations:install
41+
This will install the initializer:
5642

57-
After upgrading Client Side Validations. There is a good chance that the
58-
rails.validations.js file has changed.
43+
```
44+
config/initializers/client_side_validations.rb
45+
```
5946

6047
## Usage ##
6148

62-
### Rails 3.1 ###
6349
The javascript file is served up in the asset pipeline. Add the
6450
following to your `app/assets/javascripts/application.js` file.
6551

6652
```javascript
6753
//= require rails.validations
6854
```
6955

70-
### Rails 3.0 ###
71-
Client Side Validations requires [jQuery](http://jquery.com) version >= 1.6
72-
73-
Include the `rails.validations.js` file in your layout
74-
75-
```erb
76-
<%= javascript_include_tag 'jquery', 'rails.validations'-%>
77-
```
78-
79-
Turn on the validations for each `form_for`
80-
81-
```erb
82-
<%= form_for @book, :validate => true do |book| -%>
83-
```
84-
85-
Nested fields automatically inherit the `:validate` value. If you want to
86-
turn it off pass `:validate => false` to `fields_for`
87-
88-
```erb
89-
<%= book.fields_for :pages, :validate => false do |page| -%>
90-
```
91-
9256
## Initializer ##
9357

9458
The initializer includes a commented out `ActionView::Base.field_error_proc`.
@@ -104,14 +68,46 @@ validation error messages please use what is in
10468
## Client Side Validation Callbacks ##
10569
[See the wiki](https://github.com/bcardarella/client_side_validations/wiki/Callbacks)
10670

107-
## Known Issues ##
10871

109-
The major outstanding issue is with radio buttons. [See the open ticket](https://github.com/bcardarella/client_side_validations/issues#issue/24).
72+
## Plugins ##
73+
74+
There is additional support for other `ActiveModel` based ORMs and other
75+
Rails `FormBuilders`. Please see the [Plugin wiki page](https://github.com/bcardarella/client_side_validations/wiki/Plugins)
76+
77+
## Authors ##
78+
79+
[Brian Cardarella](http://twitter.com/bcardarella)
80+
81+
## Versioning ##
82+
83+
This gem follows [Semantic Versioning](http://semver.org)
84+
85+
Major and minor version numbers will follow `Rails`'s major and
86+
minor version numbers. For example,
87+
`client_side_validations-3.2.0` will be compatible up to
88+
`~> rails-3.2.0`
89+
90+
We will maintain compatibility with one minor version back. So the 3.2.0 version of
91+
`client_side_validations` will be compatible with `~> rails-3.1.0`
92+
93+
Only two versions minor versions will be actively maintained.
94+
95+
## Want to help? ##
96+
97+
Stable branches are created based upon each minor version. Please make
98+
pull requests to specific branches rather than master.
99+
100+
Please make sure you include tests!
101+
102+
Unles Rails drops support for Ruby 1.8.7 we will continue to use the
103+
hash-rocket syntax. Please respect this.
104+
105+
Don't use tabs to indent, two spaces are the standard.
110106

111107
## Legal ##
112108

113-
Brian Cardarella &copy; 2011
109+
[DockYard](http://dockyard.com), LLC &copy; 2012
114110

115-
[@bcardarella](http://twitter.com/bcardarella)
111+
[@dockyard](http://twitter.com/dockyard)
116112

117113
[Licensed under the MIT license](http://www.opensource.org/licenses/mit-license.php)

0 commit comments

Comments
 (0)