diff --git a/index.md b/index.md index 5b22e14..9ff9829 100644 --- a/index.md +++ b/index.md @@ -1,19 +1,25 @@ # Slugtastic -Simple gem for autogenerating permalink style slugs for your ActiveRecord models. +[![Codeship Status for danbee/slugtastic](https://codeship.com/projects/7a08ef30-0518-0132-d4b6-223503fac7d3/status?branch=master)](https://codeship.com/projects/30797) + +[![Gem Version](https://badge.fury.io/rb/slugtastic.svg)](https://badge.fury.io/rb/slugtastic) + +Simple gem for autogenerating permalink style slugs for your ActiveRecord +models. ## Requirements -* Ruby 1.9.2 or 1.9.3 -* Rails 3.1 or higher. +* Ruby 2.2.0+ +* Rails 5 or higher. -It should work with Rails 3.0 but it hasn't been tested. +It will probably work just find with earlier versions--down to Rails 3.1 and +Ruby 1.9.3--but it's not tested. ## Installation Add this line to your application's Gemfile: - gem 'slugtastic' + gem "slugtastic" And then execute: @@ -27,9 +33,11 @@ Or install it yourself as: Usage is very simple. Just add the following to your model: - has_slug :slug, :from => :title + slug :slug, from: :title -This will generate a slug string from the title atrribute and store it in the slug attribute unless the slug already contains a string. The slug is generated pre-validation so you can still use `validates_presence_of :slug`. +This will generate a slug string from the title attribute and store it in the +slug attribute unless the slug already contains a string. The slug is generated +pre-validation so you can still use `validates_presence_of :slug`. There are no extra options at present.