Add README and crate description

andiflabs · andiflabs · commit 8a30c397fe46 · 2024-10-23T14:28:34.000-07:00
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
 name = "ironfish-frost"
 version = "0.1.0"
+description = "Implementation of multi-signature primitives for the Iron Fish chain, based on the FROST protocol"
 license = "MPL-2.0"
 edition = "2021"
 
diff --git a/README.md b/README.md
@@ -0,0 +1,8 @@
+# ironfish-frost
+
+Implementation of multi-signature primitives for the Iron Fish chain.
+
+This is heavily based on the [FROST][frost] protocol from Zcash, and contains
+improvements for secure and authenticated communication between participants.
+
+[frost]: https://zfnd.org/frost/
