Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add readme #2

Merged
merged 1 commit into from
Apr 4, 2023
Merged

feat: add readme #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)):
Expand Down