diff --git a/README.rdoc b/README.md similarity index 87% rename from README.rdoc rename to README.md index ed3f812..55d07c0 100644 --- a/README.rdoc +++ b/README.md @@ -1,6 +1,6 @@ -= amatch - Approximate Matching Extension for Ruby +# amatch - Approximate Matching Extension for Ruby -== Description +## Description This is a collection of classes that can be used for Approximate matching, searching, and comparing of Strings. They implement algorithms @@ -8,31 +8,32 @@ that compute the Levenshtein edit distance, Sellers edit distance, the Hamming distance, the longest common subsequence length, the longest common substring length, the pair distance metric, the Jaro-Winkler metric. -== Download +## Download The latest version of amatch can be found at -* http://rubyforge.org/frs/?group_id=390 +* Online Documentation should be located at -* http://amatch.rubyforge.org +* -== Installation +## Installation Just type into the command line as root: - # ruby install.rb +`ruby install.rb` If you have installed rake (rake.rubyforge.org), you can also type: - # rake install +`rake install` To install this extension as a gem type - # gem install amatch +`gem install amatch` -== Examples +## Examples +~~~ruby require 'amatch' # => true include Amatch @@ -116,12 +117,16 @@ To install this extension as a gem type # => 0.961904762046678 "pattern language".jarowinkler_similar("language of patterns") # => 0.672222222222222 +~~~ -== Author +## Performance +![performance](http://cs304915.userapi.com/v304915401/5c97/BAzazF5E4Fo.jpg) -Florian Frank mailto:flori@ping.de +## Author -== License +Florian Frank + +## License This is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License Version 2 as published by