fuzzy_matcher 0.0.3 → 0.0.4

data/README.md

@@ -1,6 +1,6 @@
 # FuzzyMatcher
 
-TODO: Write a gem description
+Gem for fuzzy searching with FQA algorithm.
 
 ## Installation
 
@@ -16,9 +16,37 @@ Or install it yourself as:
 
     $ gem install fuzzy_matcher
 
+## Avalable databases
+
+Currently supported Postgresql('pg') and Mysql('mysql')
+
+## Requirements
+
+Tested in ruby 1.9.2.
+Gems needed - pg, mysql2.
+In DB you should have metric calculation function (f.e. 'levenshtein' in pg and 'damlev' in mysql).
+In Mysql you should compile damlev.so
+In Postgre you have function fuzzystrmatch
+
 ## Usage
 
-TODO: Write usage instructions here
+First add require if you use it in separate script:
+    require 'fuzzy_matcher'
+
+Next you should create connection:
+    conn = FuzzyMatcher::Adapter.new(db_type, db_name, username, password)
+F.e.
+    conn = FuzzyMatcher::Adapter.new('pg','dip_lib','postgres','password')
+
+Next step is taking node values:
+    values = FuzzyMatcher::Indexer.index!(connection, distance_methic_name, height)
+F.e.
+    values = FuzzyMatcher::Indexer.index!(conn, 'levenshtein', 2)
+
+Last is searching:
+    FuzzyMatcher::Searcher.find(values, connection, distance_methic_name, height, accuracy, aim)
+F.e. if you looking for words like 'barrels' and accuracy of searching is 3, you should write like that:
+    FuzzyMatcher::Searcher.find(values, conn, 'levenshtein', 2, 3, 'barrels')
 
 ## Contributing
 

data/lib/fuzzy_matcher/version.rb

@@ -1,3 +1,3 @@
 module FuzzyMatcher
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fuzzy_matcher
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-05-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &2160266960 !ruby/object:Gem::Requirement
+  requirement: &2157390740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160266960
+  version_requirements: *2157390740
 - !ruby/object:Gem::Dependency
   name: mysql2
-  requirement: &2160282900 !ruby/object:Gem::Requirement
+  requirement: &2157423080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160282900
+  version_requirements: *2157423080
 description: fuzzy matcher
 email:
 - graffzon@gmail.com