Skip to content

Commit

Permalink
Cleanup '@adeira/murmur-hash' in preparation for stable release
Browse files Browse the repository at this point in the history
TS definitions moved to DefinitelyTyped (DefinitelyTyped/DefinitelyTyped#49865) since we cannot maintain/test them properly. Please review that PR as well.

I'd like to release a stable version once we merge the TS types PR.
  • Loading branch information
mrtnzlml committed Nov 30, 2020
1 parent e392e10 commit 2f81292
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
8 changes: 6 additions & 2 deletions src/murmur-hash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ Read more about MurmurHash in this Stack Overflow question: [MurmurHash - what i
yarn add @adeira/murmur-hash
```

Optionally, install TS types (Flow types are included by default):

```text
yarn add --dev @types/adeira__murmur-hash
```

# Basic usage

```js
Expand All @@ -17,5 +23,3 @@ const data = { arg: { count: 20, start: 0, end: 5 } };
const hash = murmurHash(JSON.stringify(data));
console.log(hash); // 4gykY2
```

Flow and Typescript supported.
1 change: 0 additions & 1 deletion src/murmur-hash/src/murmurHash.d.ts

This file was deleted.

0 comments on commit 2f81292

Please sign in to comment.