From 89cc10e262a81dfa067b4f7d5c9cea0625d8e286 Mon Sep 17 00:00:00 2001
From: milk1000cc <info@milk1000.cc>
Date: Sun, 15 Jun 2014 18:41:48 +0900
Subject: [PATCH] Use markdown format in readme file

---
 README.md   | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.rdoc | 70 -------------------------------------------
 2 files changed, 86 insertions(+), 70 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.rdoc

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..345961e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,86 @@
+# ActsAsDigestedOn [![Build Status](https://travis-ci.org/milk1000cc/acts_as_digested_on.svg)](https://travis-ci.org/milk1000cc/acts_as_digested_on)
+
+acts_as_digested_on is a gem for Rails 3 and Rails 4.
+
+This sets the digested value before validation and validates uniqueness of the digested value.
+
+If you use this gem for Rails 2, see rails-2 branch.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_digested_on'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_digested_on
+
+## Usage
+
+```ruby
+# db/migrate/20090706000000_create_articles.rb
+class CreateArticles < ActiveRecord::Migration
+  def self.up
+    create_table :articles do |t|
+      t.text :url       # any type is ok
+      t.string :digest  # this is sha-1 hex digest field of url value
+      ...
+    end
+
+    add_index :articles, :digest, :unique => true  # you can add index on digest field
+  end
+
+  def self.down
+    drop_table :articles
+  end
+end
+
+# app/models/article.rb
+class Article < ActiveRecord::Base
+  acts_as_digested_on :url  # please add this
+  ...
+end
+
+# this means
+class Article < ActiveRecord::Base
+  validates_uniqueness_of :digest
+  before_validation :set_digest
+
+  def generate_digest
+    Digest::SHA1.hexdigest "--#{ url.to_s }--"
+  end
+
+  private
+  def set_digest
+    self.digest = generate_digest
+  end
+  ...
+end
+```
+
+## Examples
+
+```ruby
+acts_as_digested_on :url, :unique => false
+
+acts_as_digested_on :url, :digest_column => :url_digest
+
+acts_as_digested_on [:url, :salt]
+
+acts_as_digested_on :url, :scope => :site_id
+
+Article.new(:url => 'http://example.com').generate_digest
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/milk1000cc/acts_as_digested_on/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
diff --git a/README.rdoc b/README.rdoc
deleted file mode 100644
index d99199f..0000000
--- a/README.rdoc
+++ /dev/null
@@ -1,70 +0,0 @@
-= ActsAsDigestedOn {<img src="https://secure.travis-ci.org/milk1000cc/acts_as_digested_on.png?branch=master" alt="Build Status" />}[http://travis-ci.org/milk1000cc/acts_as_digested_on]
-
-acts_as_digested_on is a gem for Rails 3 and Rails 4.
-
-This sets the digested value before validation and validates uniqueness of the digested value.
-
-If you use this gem for Rails 2, see rails-2 branch.
-
-== Install
-
-  sudo gem install acts_as_digested_on
-
-== Usage
-
-  # db/migrate/20090706000000_create_articles.rb
-  class CreateArticles < ActiveRecord::Migration
-    def self.up
-      create_table :articles do |t|
-        t.text :url       # any type is ok
-        t.string :digest  # this is sha-1 hex digest field of url value
-        ...
-      end
-
-      add_index :articles, :digest, :unique => true  # you can add index on digest field
-    end
-
-    def self.down
-      drop_table :articles
-    end
-  end
-
-  # app/models/article.rb
-  class Article < ActiveRecord::Base
-    acts_as_digested_on :url  # please add this
-    ...
-  end
-
-  # this means
-  class Article < ActiveRecord::Base
-    validates_uniqueness_of :digest
-    before_validation :set_digest
-
-    def generate_digest
-      Digest::SHA1.hexdigest "--#{ url.to_s }--"
-    end
-
-    private
-    def set_digest
-      self.digest = generate_digest
-    end
-    ...
-  end
-
-== Examples
-
-  acts_as_digested_on :url, :unique => false
-
-  acts_as_digested_on :url, :digest_column => :url_digest
-
-  acts_as_digested_on [:url, :salt]
-
-  acts_as_digested_on :url, :scope => :site_id
-
-  Article.new(:url => 'http://example.com').generate_digest
-
-== Copyright
-
-Copyright (c) 2009-2013 milk1000cc, released under the MIT license
-
-milk1000cc <mailto:info@milk1000.cc>