Home

The API documentation for FriendlyId can always be found at:

http://norman.github.com/friendly_id/

Helpful Hint:
Make sure that you don’t have a column called ‘slug’ on the model that you are applying this to. It will definitely throw errors and cause major headaches.

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
[Guide](http://norman.github.io/friendly_id/file.Guide.html),
which compiles the top-level RDocs into one outlined document.

For a getting started video, you may want to watch [GoRails #9](https://gorails.com/episodes/pretty-urls-with-friendly-id)

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.