feat: add readme (#2)

bdraco · Apr 4, 2023 · c7fec4b · c7fec4b
1 parent eb4612d
commit c7fec4b
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -29,12 +29,24 @@
 
 A fast version of fnv1a
 
+This library will use a CPP implementation of fnv1a (32) if cython is available, and will fallback to pure python from the fnvhash package if it is not.
+
 ## Installation
 
 Install this via pip (or your favourite package manager):
 
 `pip install fnv-hash-fast`
 
+## Example
+
+```python
+>>> import fnv_hash_fast
+>>> fnv_hash_fast.fnv1a_32(b"hello")
+1335831723
+>>> fnv_hash_fast.fnv1a_32(b"goodbye")
+1188507472
+```
+
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):