Skip to content

Commit ef21169

Browse files
committed
list the implementations in every language with their packages in the readme
1 parent 75e0580 commit ef21169

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,20 @@ produces, byte for byte, the output of the C++ reference implementation
1818
[hh-cpp](https://github.com/censync/hh-cpp), which owns the
1919
[specification](https://github.com/censync/hh-cpp/blob/v1.0.0/docs/SPEC.md) and the golden vectors.
2020
`testdata/` is a byte-identical copy of those vectors; `testdata/SOURCE` names the hh-cpp release
21-
they came from. The same pictures come from [hh-kotlin](https://github.com/censync/hh-kotlin) (JVM
22-
and Android, Maven `io.github.censync:hh`), [hh-ts](https://github.com/censync/hh-ts) (TypeScript,
23-
npm `@censync/hh`) and [go-hh](https://github.com/censync/go-hh) (Go, `github.com/censync/go-hh`).
21+
they came from.
22+
23+
## Implementations
24+
25+
Every implementation produces the same pictures, tags and encoded files, byte for byte, and its
26+
tests check it against a copy of the golden vectors of hh-cpp.
27+
28+
| Language | Repository | Package | Install |
29+
|---|---|---|---|
30+
| C++17, C ABI | [hh-cpp](https://github.com/censync/hh-cpp), the reference: specification and golden vectors | CMake `hh::hh`, pkg-config `hh` ([releases](https://github.com/censync/hh-cpp/releases)) | CMake `FetchContent` or `find_package(hh)` |
31+
| Kotlin and Java: JVM, Android | [hh-kotlin](https://github.com/censync/hh-kotlin) | Maven Central [`io.github.censync:hh`](https://central.sonatype.com/artifact/io.github.censync/hh) | `implementation("io.github.censync:hh:1.0.0")` |
32+
| TypeScript and JavaScript: browsers, Node.js, Deno, Bun | [hh-ts](https://github.com/censync/hh-ts) | npm [`@censync/hh`](https://www.npmjs.com/package/@censync/hh) | `npm install @censync/hh` |
33+
| Go | [go-hh](https://github.com/censync/go-hh) | [`github.com/censync/go-hh`](https://pkg.go.dev/github.com/censync/go-hh) | `go get github.com/censync/go-hh` |
34+
| Python | hh-python (this repository) | PyPI [`humanized-hash`](https://pypi.org/project/humanized-hash/) | `pip install humanized-hash` |
2435

2536
## A longer example: Sui
2637

0 commit comments

Comments
 (0)