docs(readme): add a readme detailing usage

Signed-off-by: SphericalKat <[email protected]>

README.md

@@ -0,0 +1,56 @@
+# FuzzyWuzzy
+
+This is a dart port of the popular [FuzzyWuzzy](https://github.com/seatgeek/fuzzywuzzy) python package. This algorithm uses [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) to calculate similarity between strings.
+
+I personally needed to use this for my own search algorithms, and there weren't any packages as good as my experience with FuzzyWuzzy was, so here we are. Enjoy!
+
+- No dependencies.
+- Pure Dart implementation of the superfast [python-Levenshtein](https://github.com/ztane/python-Levenshtein/).
+- Simple to use.
+- Lightweight.
+- Massive props to the folks over at seatgeek for coming up with the [algorithm](http://chairnerd.seatgeek.com/fuzzywuzzy-fuzzy-string-matching-in-python/).
+
+## Get started
+
+### Add dependency
+
+```yaml
+dependencies:
+    fuzzywuzzy: 0.1.0 # latest version
+```
+
+
+## Usage
+First, import the package
+```dart
+import 'package:fuzzywuzzy/fuzzywuzzy.dart'
+```
+
+
+### Simple ratio
+```dart
+ratio("mysmilarstring", "myawfullysimilarstirng") // 72
+ratio("mysmilarstring", "mysimilarstring")        // 97
+```
+
+### Partial ratio
+```dart
+partialRatio("similar", "somewhresimlrbetweenthisstring") // 71
+```
+
+### Token sort ratio
+```dart
+tokenSortPartialRatio("order words out of", "words out of order") // 100
+tokenSortRatio("order words out of","  words out of order")       // 100
+```
+
+### Token set ratio
+```dart
+tokenSetRatio("fuzzy was a bear", "fuzzy fuzzy fuzzy bear")         // 100
+tokenSetPartialRatio("fuzzy was a bear", "fuzzy fuzzy fuzzy bear")  // 100
+```
+
+### Weighted ratio
+```dart
+weightedRatio("The quick brown fox jimps ofver the small lazy dog", "the quick brown fox jumps over the small lazy dog") // 97
+```

lib/algorithms/weighted_ratio.dart

@@ -1,7 +1,7 @@
 import 'dart:math';
 
 import '../applicable.dart';
-import '../fuzzy_search.dart';
+import '../fuzzywuzzy.dart';
 
 class WeightedRatio implements Applicable {
   static const UNBASE_SCALE = 0.95;

lib/fuzzy_search.dart → lib/fuzzywuzzy.dart

@@ -28,8 +28,8 @@ int tokenSetPartialRatio(String s1, String s2) {
   return TokenSet().apply(s1, s2, PartialRatio());
 }
 
-/// Calculates a weighted ratio between [s1] and [s2] using several different 
-/// fuzzy matching algorithms
+/// Calculates a weighted ratio between [s1] and [s2] using the best option from 
+/// the above fuzzy matching algorithms
 /// 
 /// Example:
 /// ```dart

pubspec.lock

@@ -2,4 +2,4 @@
 # See https://dart.dev/tools/pub/glossary#lockfile
 packages: {}
 sdks:
-  dart: ">=2.7.0 <3.0.0"
+  dart: ">=2.12.0 <3.0.0"

pubspec.yaml

@@ -4,4 +4,4 @@ homepage: "https://github.com/sphericalkat/dart-fuzzywuzzy"
 description: An implementation of the popular fuzzywuzzy package in dart
 
 environment:
-  sdk: ">=2.7.0 <3.0.0"
+  sdk: ">=2.12.0 <3.0.0"