Permalink
Browse files

updated readme

  • Loading branch information...
1 parent 9ce8915 commit a90eec837284cb62227617f8f27201e60be8dcc6 @josegonzalez josegonzalez committed Jul 8, 2011
Showing with 78 additions and 32 deletions.
  1. +78 −0 README.textile
  2. +0 −32 README.txt
View
@@ -0,0 +1,78 @@
+h1. FuzzyWuzzy
+
+Fuzzy string matching like a boss.
+
+h2. Requirements
+
+* Python 2.4 or higher
+* difflib
+
+h2. Installation
+
+_[Manual]_
+
+# Download this: http://github.com/seatgeek/fuzzywuzzy/zipball/master
+# Unzip that download.
+# run python setup.py install
+
+_[GIT Clone]_
+
+In a directory of your choice, type:
+<pre><code>git clone git://github.com/seatgeek/fuzzywuzzy.git fuzzywuzzy
+python setup.py install</code></pre>
+
+h2. Usage
+
+<pre><code>> from fuzzywuzzy import fuzz
+> from fuzzywuzzy import process</code></pre>
+
+h3. SIMPLE RATIO
+
+<pre><code>> fuzz.ratio("this is a test", "this is a test!")
+ 96
+</code></pre>
+
+h3. PARTIAL RATIO
+
+<pre><code>> fuzz.partial_ratio("this is a test", "this is a test!")
+ 100
+</code></pre>
+
+h3. TOKEN SET RATIO
+
+<pre><code>> fuzz.ratio("fuzzy wuzzy was a bear", "wuzzy fuzzy was a bear")
+ 90
+> fuzz.token_sort_ratio("fuzzy wuzzy was a bear", "wuzzy fuzzy was a bear")
+ 100
+</code></pre>
+
+h3. TOKEN SET RATIO
+
+<pre><code>> fuzz.token_sort_ratio("fuzzy was a bear", "fuzzy fuzzy was a bear")
+ 84
+> fuzz.token_set_ratio("fuzzy was a bear", "fuzzy fuzzy was a bear")
+ 100
+</code></pre>
+
+h2. License
+
+Copyright (c) 2011 Adam Cohen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -1,32 +0,0 @@
-INSTALLATION INSTRUCTIONS
-
-1) Download tarball or clone git repository
-2) run python setup.py install
-
-USING FUZZYWUZZY (examples)
-
-> from fuzzywuzzy import fuzz
-> from fuzzywuzzy import process
-
-# SIMPLE RATIO
-> fuzz.ratio("this is a test", "this is a test!")
-96
-
-# PARTIAL RATIO
-> fuzz.partial_ratio("this is a test", "this is a test!")
-100
-
-# TOKEN SET RATIO
-> fuzz.ratio("fuzzy wuzzy was a bear", "wuzzy fuzzy was a bear")
-90
-> fuzz.token_sort_ratio("fuzzy wuzzy was a bear", "wuzzy fuzzy was a bear")
-100
-
-# TOKEN SET RATIO
-> fuzz.token_sort_ratio("fuzzy was a bear", "fuzzy fuzzy was a bear")
-84
-> fuzz.token_set_ratio("fuzzy was a bear", "fuzzy fuzzy was a bear")
-100
-
-
-

0 comments on commit a90eec8

Please sign in to comment.