Browse files

Installation and made instructions clearer

  • Loading branch information...
1 parent a90e2dd commit 2f78a4d916849374a66155464bdb0feafd8f8a1f Jose Fernandez committed May 21, 2008
Showing with 9 additions and 1 deletion.
  1. +9 −1 README.markdown
10 README.markdown
@@ -1,10 +1,18 @@
## SaltySlugs
Abstraction of word-based slugs for URLs, w/ or w/o leading numeric IDs.
+## Installation
+* Using Rails 2.1+
+ ./script/plugin install git://
## Instructions
-* Defaults to 'title' as the source column and 'slug' as the slug column. Prepends the model ID
+* SaltySlugs defaults to `title` as the `source_column` and `slug` as the `slug_column`, and prepends the model ID. Upon creating/updating a record, the plugin will sluggify the `source_column` when `slug_column` is empty, otherwise it will sluggify the `slug_column`.
class Post < ActiveRecord::Base

0 comments on commit 2f78a4d

Please sign in to comment.