Merge pull request #6 from escherba/es/readme

update readme

Author: escherba

README.rst

@@ -28,8 +28,11 @@ To use this package in your program, simply type
 After that, you should be able to import the module and do things with it (see
 Example Usage below).
 
-Example Usage
--------------
+Usage Examples
+--------------
+
+Simple Hashing
+~~~~~~~~~~~~~~
 
 This package provides Python interfaces to 64- and 128-bit implementations of
 MetroHash algorithm. For stateless hashing, it exports ``metrohash64`` and
@@ -46,6 +49,9 @@ unicode) and an optional ``seed`` parameter:
     182995299641628952910564950850867298725
 
 
+Incremental Hashing
+~~~~~~~~~~~~~~~~~~~
+
 For incremental hashing, use ``MetroHash64`` and ``MetroHash128`` classes.
 Incremental hashing is associative and guarantees that any combination of input
 slices will result in the same final hash value. This is useful for processing
@@ -69,7 +75,7 @@ Note that the resulting hash value above is the same as in:
     7851180100622203313
 
 Buffer Protocol Support
------------------------
+~~~~~~~~~~~~~~~~~~~~~~~
 
 The methods in this module support Python `Buffer Protocol
 <https://docs.python.org/3/c-api/buffer.html>`__, which allows them to be used

pip-freeze.txt

@@ -1,29 +1,19 @@
 attrs==21.3.0
-backcall==0.2.0
 Cython==0.29.26
-decorator==5.1.0
 distlib==0.3.4
 filelock==3.4.2
+importlib-metadata==4.10.0
 iniconfig==1.1.1
-ipython==7.30.1
-jedi==0.18.1
-matplotlib-inline==0.1.3
--e git+https://github.com/escherba/python-metrohash@d3f96245c18e7e3724b8e8c8c211ff5c524beed0#egg=metrohash
+-e git+https://github.com/escherba/python-metrohash@5b2b36b09262853950816ff3852ebda5a8c2779c#egg=metrohash
 numpy==1.21.5
 packaging==21.3
-parso==0.8.3
-pexpect==4.8.0
-pickleshare==0.7.5
 platformdirs==2.4.1
 pluggy==1.0.0
-prompt-toolkit==3.0.24
-ptyprocess==0.7.0
 py==1.11.0
-Pygments==2.10.0
 pyparsing==3.0.6
 pytest==6.2.5
 six==1.16.0
 toml==0.10.2
-traitlets==5.1.1
-virtualenv==20.11.0
-wcwidth==0.2.5
+typing_extensions==4.0.1
+virtualenv==20.11.1
+zipp==3.6.0

setup.py

@@ -78,7 +78,7 @@ def is_pure(self):
         )
 
 
-VERSION = '0.1.0.post0'
+VERSION = '0.1.0.post1'
 URL = "https://github.com/escherba/python-metrohash"
 
 

src/metrohash.cpp

@@ -8,7 +8,7 @@ Python wrapper for MetroHash, a fast non-cryptographic hashing algorithm
 
 __author__  = "Eugene Scherba"
 __email__   = "escherba+metrohash@gmail.com"
-__version__ = "0.1.0.post0"
+__version__ = "0.1.0.post1"
 __all__     = [
     "metrohash64",
     "metrohash128",