Skip to content

Commit

Permalink
Breaking things
Browse files Browse the repository at this point in the history
  • Loading branch information
tagliala committed Mar 21, 2015
1 parent 5892ec9 commit 0bf008c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 82 deletions.
83 changes: 2 additions & 81 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,3 @@
# ClientSideValidations-Turbolinks #
# Do not use this gem

[![Gem Version](https://badge.fury.io/rb/client_side_validations-turbolinks.svg)](http://badge.fury.io/rb/client_side_validations-turbolinks)
[![Build Status](https://secure.travis-ci.org/DavyJonesLocker/client_side_validations-turbolinks.svg?branch=master)](https://travis-ci.org/DavyJonesLocker/client_side_validations-turbolinks)
[![Dependency Status](https://gemnasium.com/DavyJonesLocker/client_side_validations-turbolinks.svg)](https://gemnasium.com/DavyJonesLocker/client_side_validations-turbolinks)
[![Code Climate](https://codeclimate.com/github/DavyJonesLocker/client_side_validations-turbolinks/badges/gpa.svg)](https://codeclimate.com/github/DavyJonesLocker/client_side_validations-turbolinks)
[![Coverage Status](https://coveralls.io/repos/DavyJonesLocker/client_side_validations-turbolinks/badge.svg)](https://coveralls.io/r/DavyJonesLocker/client_side_validations-turbolinks)

[Turbolinks](https://github.com/rails/turbolinks) plugin for [ClientSideValidations](https://github.com/DavyJonesLocker/client_side_validations)

## Installation ##

In your Gemfile add the following:

```ruby
gem 'turbolinks'
gem 'client_side_validations'
gem 'client_side_validations-turbolinks'
```

Order matters here. `Turbolinks` and `ClientSideValidations` need to be
required **before** `ClientSideValidations-Turbolinks`.

[Follow the remaining installation instructions for ClientSideValidations](https://github.com/DavyJonesLocker/client_side_validations/README.markdown)

Add the following line to `app/assets/javascripts/application.js`

```javascript
//= require rails.validations.turbolinks
```

Again, order matters. You should add this line after the require for `rails.validations` as described in the `ClientSideValidations` installation instructions.

If the asset pipeline is disabled the asset file will be copied
into `public/javascripts` when the `ClientSideValidations` install generator is run.

At any time you can copy the asset file into your project by running:

```
rails g client_side_validations:copy_assets
```

If the asset pipeline is disabled the asset file will be copied
into `public/javascripts`. Otherwise the asset file will be copied into
`app/assets/javascripts` (or whatever asset directory you have
defined)

## Usage ##

As long as you are using `Turbolinks` properly this should "just work". Any new forms that are candiadates for
`ClientSideValidations` will be applied on every `page:change` event.

## Authors ##

[Brian Cardarella](http://twitter.com/bcardarella)

[Geremia Taglialatela](http://twitter.com/gtagliala)

[We are very thankful for the many contributors](https://github.com/DavyJonesLocker/client_side_validations-turbolinks/graphs/contributors)

## Versioning ##

This gem follows [Semantic Versioning](http://semver.org)

Major and minor version numbers will follow `Turbolinks`'s major and
minor version numbers. For example,
`client_side_validations-turbolinks-2.5.0` will be compatible up to
`~> turbolinks-2.5.0`

## Want to help? ##

Please do! We are always looking to improve this gem. Please see our
[Contribution Guidelines](https://github.com/DavyJonesLocker/client_side_validations-turbolinks/blob/master/CONTRIBUTING.md)
on how to properly submit issues and pull requests.

## Legal ##

[DockYard](http://dockyard.com), LLC © 2012-2015

[@dockyard](http://twitter.com/dockyard)

[Licensed under the MIT license](http://www.opensource.org/licenses/mit-license.php)
Client Side Validations supports Turbolinks out of the box
2 changes: 1 addition & 1 deletion client_side_validations-turbolinks.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Gem::Specification.new do |s|
s.files = `git ls-files -- {lib/*,vendor/*,*.gemspec}`.split("\n")
s.require_paths = ['lib']

s.add_dependency 'client_side_validations', '~> 4.2.0'
s.add_dependency 'client_side_validations', '~> 0.0.0'
s.add_dependency 'turbolinks', '~> 2.5'

s.add_development_dependency 'mocha', '~> 1.1'
Expand Down

0 comments on commit 0bf008c

Please sign in to comment.