README.md in solidus_support-0.1.0 vs README.md in solidus_support-0.1.1

- old
+ new

@@ -1,36 +1,36 @@ # SolidusSupport -Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/solidus_support`. To experiment with that code, run `bin/console` for an interactive prompt. +This gem holds some common functionality for Solidus Extensions. -TODO: Delete this and the text above, and describe your gem +It has some utilities to make it easier to support multiple versions of Solidus. -## Installation +## Usage -Add this line to your application's Gemfile: +### `SolidusSupport::Migration` -```ruby -gem 'solidus_support' -``` +Rails >= 5 introduced the concept of specifying what rails version your migration was written for, like `ActiveRecord::Migration[5.0]`. +Not specifying a version is deprecated in Rails 5.0 and removed in rails 5.1. +This wasn't backported to Rails 4.2, but Rails 4.2 _is_ Rails 4.2. So we provide this helper. -And then execute: +``` ruby +# On Rails 4.2 +SolidusSupport::Migration[4.2] # returns `ActiveRecord::Migration` +SolidusSupport::Migration[5.0] # errors - $ bundle +# On Rails 5.0 +SolidusSupport::Migration[4.2] # same as `ActiveRecord::Migration[4.2]` +SolidusSupport::Migration[5.0] # same as `ActiveRecord::Migration[5.0]` +``` -Or install it yourself as: +There's no reason to use `SolidusSupport::Migration[5.0]` over `ActiveRecord::Migration[5.0]`, but it is provided. - $ gem install solidus_support - -## Usage - -TODO: Write usage instructions here - ## Development After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/jhawthorn/solidus_support. +Bug reports and pull requests are welcome on GitHub at https://github.com/solidusio/solidus_support.