Readme modified

bahriddin · Sep 3, 2017 · 9e9c40a · 9e9c40a
1 parent 7080c33
commit 9e9c40a
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 23 deletions.
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/README.md b/README.md
@@ -0,0 +1,10 @@
+This package (MIDR) calculates global edit distance and local edit distance.
+how to use:
+1. Import Midr class from midr package:
+    ```from midr import Midr```
+2. create object giving 4 parameters (M - match score, I - insert score, D - delete score, 
+R - replace score, default: 0, 1, 1, 1 - Livenstein distance):
+    ```obj = Midr(1, -1, -1, -1)```
+3. Calculate distance between 2 strings:
+    ```obj.global_edit_distance(word1, word2)```
+    ```obj.local_edit_distance(word1, word2)```