From b8ec30fc2c170b1ad9b9c50dd35a3a8a1b198f03 Mon Sep 17 00:00:00 2001
From: Joost Rijneveld <joost@joostrijneveld.nl>
Date: Sat, 22 Jul 2017 16:41:37 +0200
Subject: [PATCH] Clarify compile-time parameters in README

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d2ff8e6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+## XMSS reference code
+
+This repository contains the reference implementation that accompanies the Internet Draft _"XMSS: Extended Hash-Based Signatures"_, [`draft-irtf-cfrg-xmss-hash-based-signatures`](https://datatracker.ietf.org/doc/draft-irtf-cfrg-xmss-hash-based-signatures/).
+
+**Note:** while the behaviour of the code in this repository is supposed to be stable, the API will still vary. Notably, the current codebase does not account for the XDR definitions of the parameter sets as specified in the Internet Draft, but instead allows the user to set individual parameters.
\ No newline at end of file