README.md in friendly_id-5.0.0.beta4 vs README.md in friendly_id-5.0.0.rc1
- old
+ new
@@ -13,11 +13,11 @@
which is the current 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://rubydoc.info/github/norman/friendly_id/master/file/Guide.md).</em>
+<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
Active Record. It lets you create pretty URLs and work with human-friendly
strings as if they were numeric ids.
@@ -89,15 +89,17 @@
restaurant.slug = nil
restaurant.save!
restaurant.friendly_id # the-plaza-diner
You can restore some of the old behavior by overriding the
- `should_generate_new_friendly_id` method.
+ `should_generate_new_friendly_id?` method.
* The `friendly_id` Rails generator now generates an initializer showing you
how to do some commmon global configuration.
+* The Globalize plugin has moved to a separate gem (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.
@@ -125,13 +127,18 @@
add_index :friendly_id_slugs, [:slug, :sluggable_type, :scope], unique: true
## Docs
The most current docs from the master branch can always be found
-[here](http://rubydoc.info/github/norman/friendly_id/master/frames).
+[here](http://norman.github.io/friendly_id).
+Docs for older versions are also available:
+
+* [4.0](http://norman.github.io/friendly_id/4.0/)
+* [3.3](http://norman.github.io/friendly_id/3.3/)
+
The best place to start is with the
-[Guide](http://rubydoc.info/github/norman/friendly_id/master/file/Guide.md),
+[Guide](http://norman.github.io/friendly_id/file.Guide.html),
which compiles the top-level RDocs into one outlined document.
You might also want to watch Ryan Bates's [Railscast on FriendlyId](http://railscasts.com/episodes/314-pretty-urls-with-friendlyid),
which is now somewhat outdated but still relevant.