2 files changed, 55 insertions(+), 1 deletions(-)

A README.rst
M pyphonetics/__init__.py

@@ 0,0 1,54 @@
+===========
+Pyphonetics
+===========
+
+Pyphonetics is a Python 3 library for phonetic algorithms. Right now, the following algorithms are implemented and supported:
+
+ * Soundex
+ * Metaphone
+ * Refined Soundex
+ * Fuzzy Soundex
+ * Lein
+ * Matching Rating Approach
+
+More will be added in the future.
+
+Instalation
+***********
+
+The module is available in PyPI, just use `pip install pyphonetics`.
+
+
+Usage
+*****
+
+    >>> from pyphonetics import Soundex
+    >>> soundex = Soundex()
+    >>> soundex.phonetics('Rupert')
+    'R163'
+    >>> soundex.phonetics('Robert')
+    'R163'
+    >>> soundex.sounds_like('Robert', 'Rupert')
+    True
+
+
+The same API applies to every algorithm, e.g:
+
+    >>> from pyphonetics import Metaphone
+    >>> metaphone = Metaphone()
+    >>> metaphone.phonetics('discrimination')
+    'TSKRMNXN'
+
+You can also use the `distance(word1, word2, metric='levenshtein')` method to find the distance between 2 phonetic representations.
+
+    >>> from pyphonetics import RefinedSoundex
+    >>> rs = RefinedSoundex()
+    >>> rs.distance('Rupert', 'Robert')
+    0
+    >>> rs.distance('assign', 'assist', metric='hamming')
+    2
+
+Credits
+=======
+
+The module was largely based on the implementation of phonetic algorithms found in the Talisman.js (https://github.com/Yomguithereal/talisman) Node NLP library.<
\ No newline at end of file

@@ 6,4 6,4 @@ from .phonetics import (Soundex,
                         Lein,
                         RefinedSoundex)
 
-__version__ = '0.5'
+__version__ = '0.5.1'