README.md in friendly_id-5.2.4 vs README.md in friendly_id-5.2.5
- old
+ new
@@ -37,26 +37,30 @@
## Usage
Add this line to your application's Gemfile:
```ruby
-gem 'friendly_id', '~> 5.1.0' # Note: You MUST use 5.0.0 or greater for Rails 4.0+
+gem 'friendly_id', '~> 5.2.4' # Note: You MUST use 5.0.0 or greater for Rails 4.0+
```
And then execute:
```shell
bundle install
```
-Generate the friendly configuration file
+Add a `slug` column to the desired table (e.g. `Users`)
+```shell
+rails g migration AddSlugToUsers slug:uniq
+```
+Generate the friendly configuration file and a new migration
+
```shell
rails generate friendly_id
```
->Temp solution for Rails 5.1+ : Before running the migration, go into the generated migration file and specify the Rails version:
-`class CreateFriendlyIdSlugs < ActiveRecord::Migration[5.1]`
+Note: You can delete the `CreateFriendlyIdSlugs` migration if you won't use the slug history feature. ([Read more](https://norman.github.io/friendly_id/FriendlyId/History.html))
Run the migration scripts
```shell
rails db:migrate