couchrest_model_slug 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,3 +1,54 @@
-= CouchrestModelSlug
+== CouchRest Model Slug
 
-This project rocks and uses MIT-LICENSE.
+CouchRest Model Slug is a simple gem to generate better urls using CouchRest Model in an easy way.
+It's based on Mongoid Slug https://github.com/papercavalier/mongoid-slug
+
+Time to relax with beautiful urls.
+
+== Getting Started
+
+Add to Gemfile
+
+  gem "couchrest_model_slug", "~> 0.0.1"
+  
+A model example
+
+  class Post < CouchRest::Model::Base
+    include CouchRest::Model::Slug
+
+    property :title
+    property :summary
+    property :text
+
+    slug :title, :summary
+  end
+  
+It's all you need to get things working =)
+  
+== Querying
+
+  p = Post.create(:title => "CouchDB", :summary => "Time to relax!")
+  p.to_param # => "couchdb-time-to-relax"
+  
+  Post.find("couchdb-time-to-relax") # =>#<Post slug: "couchdb-time-to-relax", title: "CouchDB"...
+  
+== Special feature
+
+CouchRest Model Slug was made to work with or without slugged value, then it uses the id to keep things running with no problems.
+  
+  Post.create(:text => "post without slug") # => #<Post slug: "", title: nil, summary: nil, text: "post with no slug", _id: "9fdfdd090897680de59091c8c98ff064"...
+  
+  Post.find("9fdfdd090897680de59091c8c98ff064") # => #<Post slug: "", title: nil, summary: nil, text: "post with no slug", _id: "9fdfdd090897680de59091c8c98ff064"...
+  
+== Notes
+
+CouchRest Model Slug automatically adds a property called slug into your model to store the slugged value.
+Then you can call the slug property directly.
+  
+  p = Post.create(:title => "CouchDB", :summary => "Time to relax!")
+  p.slug # => "couchdb-time-to-relax"
+  
+If you want to be more explicit, you can query using find_by_slug magic method:
+
+  Post.find_by_slug("couchdb-time-to-relax") # =>#<Post slug: "couchdb-time-to-relax", title: "CouchDB"...
+  

data/lib/couchrest/model/slug/version.rb

@@ -1,7 +1,7 @@
 module CouchRest
   module Model
     module Slug
-      VERSION = "0.0.1"
+      VERSION = "0.0.2"
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: couchrest_model_slug
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Lucas Renan
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-21 00:00:00 Z
+date: 2011-06-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: couchrest_model
@@ -18,9 +18,9 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.1.0.rc1
+        version: 1.1.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -29,7 +29,7 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
         version: 1.2.1
   type: :runtime