codex-storage/nim-poseidon2
1
0
Fork 0
mirror of https://github.com/codex-storage/nim-poseidon2.git synced 2025-02-23 16:28:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add installation instructions to Readme

Browse Source
This commit is contained in:
Mark Spanbroek 2023-10-25 10:26:32 +02:00 committed by markspanbroek
parent 331a68e4bd
commit 40eac466e2
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,8 +1,21 @@
Nim implementation of Poseidon2
-------------------------------
===============================
This one uses the constantine library, and is specialized to BN254 and t=3.
Experimental implementation of the [Poseidon 2][1] cryptographic hash function,
specialized to BN254 and t=3. Uses the [constantine][2] library for
cryptographic primitives. Neither completeness nor correctness are guaranteed at
this moment in time.
Note: this is a learning exercise, I don't speak Nim...
Installation
------------
Use the [Nimble][3] package manager to add `poseidon2` to an existing
project. Add the following to its .nimble file:
```nim
requires "poseidon2 >= 0.1.0 & < 0.2.0"
```
[1]: https://eprint.iacr.org/2023/323.pdf
[2]: https://github.com/mratsim/constantine
[3]: https://github.com/nim-lang/nimble