From 40eac466e2e323eb6e8a11ebefbd37f91cd20e4f Mon Sep 17 00:00:00 2001
From: Mark Spanbroek <mark@spanbroek.net>
Date: Wed, 25 Oct 2023 10:26:32 +0200
Subject: [PATCH] Add installation instructions to Readme

---
 README.md | 21 +++++++++++++++++----
 1 file changed, 17 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index a76ddca..f812e9d 100644
--- a/README.md
+++ b/README.md
@@ -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