README.md in friendly_id-5.0.4 vs README.md in friendly_id-5.0.5
- old
+ new
@@ -1,6 +1,8 @@
-[](https://travis-ci.org/norman/friendly_id)
+[](https://travis-ci.org/norman/friendly_id)
+[](https://codeclimate.com/github/norman/friendly_id)
+[](http://inch-ci.org/github/norman/friendly_id)
**GETTING HELP**
Please ask questions on [Stack
Overflow](http://stackoverflow.com/questions/tagged/friendly-id) using the
@@ -10,23 +12,10 @@
Please only post issues in Github issues for actual bugs.
I am asking people to do this because the same questions keep getting asked
over and over and over again in the issues.
-**VERSION NOTE**
-
-**Rails 4**:
-
-The master branch of this repository contains FriendlyId 5, the current stable version.
-5.x is the only version that is compatible with Rails 4.
-
-**Rails 3**:
-
-If you wish to use this gem with Rails 3.1 or 3.2 you must use FriendlyId 4,
-which is the previous stable release. Please see the [4.0-stable
-branch](https://github.com/norman/friendly_id/tree/4.0-stable).
-
# FriendlyId
<em>For the most complete, user-friendly documentation, see the [FriendlyId Guide](http://norman.github.io/friendly_id/file.Guide.html).</em>
FriendlyId is the "Swiss Army bulldozer" of slugging and permalink plugins for
@@ -45,10 +34,20 @@
## FriendlyId Features
FriendlyId offers many advanced features, including: slug history and
versioning, i18n, scoped slugs, reserved words, and custom slug generators.
+### What Changed in Version 5.1
+
+5.1 is a bugfix release, but bumps the minor version because some applications may be dependent
+on the previously buggy behavior. The changes include:
+
+* Blank strings can no longer be used as slugs.
+* When the first slug candidate is rejected because it is reserved, additional candidates will
+ now be considered before marking the record as invalid.
+* The `:finders` module is now compatible with Rails 4.2.
+
### What Changed in Version 5.0
As of version 5.0, FriendlyId uses [semantic versioning](http://semver.org/). Therefore, as you might
infer from the version number, 5.0 introduces changes incompatible with 4.0.
@@ -105,11 +104,11 @@
You can restore some of the old behavior by overriding the
`should_generate_new_friendly_id?` method.
* The `friendly_id` Rails generator now generates an initializer showing you
how to do some common global configuration.
-* The Globalize plugin has moved to a separate gem (currently in alpha).
+* The Globalize plugin has moved to a [separate gem](https://github.com/norman/friendly_id-globalize) (currently in alpha).
* The `:reserved` module no longer includes any default reserved words.
Previously it blocked "edit" and "new" everywhere. The default word list has
been moved to `config/initializers/friendly_id.rb` and now includes many more
words.
* The `:history` and `:scoped` addons can now be used together.
@@ -141,10 +140,11 @@
The most current docs from the master branch can always be found
[here](http://norman.github.io/friendly_id).
Docs for older versions are also available:
+* [5.0](http://norman.github.io/friendly_id/5.0/)
* [4.0](http://norman.github.io/friendly_id/4.0/)
* [3.3](http://norman.github.io/friendly_id/3.3/)
* [2.3](http://norman.github.io/friendly_id/2.3/)
The best place to start is with the
@@ -160,10 +160,10 @@
rails new my_app
cd my_app
```
```ruby
# Gemfile
-gem 'friendly_id', '~> 5.0.0' # Note: You MUST use 5.0.0 or greater for Rails 4.0+
+gem 'friendly_id', '~> 5.1.0' # Note: You MUST use 5.0.0 or greater for Rails 4.0+
```
```shell
rails generate friendly_id
rails generate scaffold user name:string slug:string:uniq
rake db:migrate