Add details to README (#339)

.gitignore

@@ -1,2 +1,3 @@
 /target
-.vscode/*
+.vscode/*
+**/.DS_Store

Makefile.toml

@@ -0,0 +1,15 @@
+[tasks.fmt]
+script = "cargo fmt"
+
+[tasks.clippy-full]
+script = "cargo clippy --all-features --all-targets -- -D warnings"
+
+[tasks.all]
+dependencies = [
+ "test",
+ "fmt",
+ "clippy-full"
+]
+
+[tasks.cov]
+script = "cargo llvm-cov --ignore-filename-regex 'tests.rs'"

README.md

@@ -1,7 +1,95 @@
 # Frost Trusted Dealer Demo
 
-A CLI demo for running trusted dealer key generation with FROST
+A CLI demo for running trusted dealer key generation with the Zcash Foundation's Rust implementation of [Two-Round Threshold Schnorr Signatures with FROST](https://datatracker.ietf.org/doc/draft-irtf-cfrg-frost/). The trusted dealer is trusted to:
+1. generate good randomness
+2. delete secret values after distributing shares to each participant
+3. keep secret values confidential.
 
-This demo uses ed25519
+This will be part of a set of demos and a proof of concept application that uses the FROST libraries and reference implementation. The purpose of these demos is to:
 
-https://crates.io/crates/frost-ed25519
+1. identify gaps in our documentation
+2. provide usage examples for developer facing documentation
+3. provide reference implementations for developers wanting to use FROST in a “real world” scenario.
+
+This demo uses the (Ed25519, SHA-512) ciphersuite. The crate can be found [here](https://crates.io/crates/frost-ed25519).
+
+## About FROST (Flexible Round-Optimised Schnorr Threshold signatures)
+
+Unlike signatures in a single-party setting, threshold signatures require cooperation among a threshold number of signers, each holding a share of a common private key. The security of threshold
+schemes in general assume that an adversary can corrupt strictly fewer than a threshold number of participants.
+
+[Two-Round Threshold Schnorr Signatures with FROST](https://datatracker.ietf.org/doc/draft-irtf-cfrg-frost/) presents a variant of a Flexible Round-Optimized Schnorr Threshold (FROST) signature scheme originally defined in [FROST20](https://eprint.iacr.org/2020/852.pdf). FROST reduces network overhead during threshold
+signing operations while employing a novel technique to protect against forgery attacks applicable to prior Schnorr-based threshold signature constructions. This variant of FROST requires two rounds to compute a signature, and implements signing efficiency improvements described by [Schnorr21](https://eprint.iacr.org/2021/1375.pdf). Single-round signing with FROST is not implemented here.
+
+## Status ⚠
+
+The Trusted Dealer demo is a WIP.
+
+## Usage
+
+NOTE: This is for demo purposes only and should not be used in production.
+
+You will need to have [Rust and Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) installed.
+
+To run:
+1. Clone the repo. Run `git clone https://github.com/ZcashFoundation/frost-zcash-demo.git`
+2. Run `cargo install`
+3. Run `cargo run`
+
+On startup, the Trusted Dealer demo will prompt for:
+
+1. Minimum number of signers (>= 2) i.e. The threshold number of signers for the secret sharing scheme.
+
+2. Maximum number of signers i.e. the number of shares to generate
+
+```
+> cargo run
+ Finished dev [unoptimized + debuginfo] target(s) in 0.05s
+ Running 'target/debug/frost-trusted-dealer-demo
+The minimum number of signers: (2 or more)
+2
+The maximum number of signers: (must be greater than minimum number of signers)
+5
+```
+
+The dealer CLI will then use that data to generate:
+
+1. The group public key
+2. A commitment to the secret
+3. Each signer's public key
+4. Each signer's secret share
+5. An identifier for each signer
+
+In a "real world" scenario, the secret share should be delivered securely to each participant. For the purposes of the Trusted Dealer demo only, the above data will be output to the terminal. 
+
+In the next round, all signers will receive the data but only the individual signers will receive their personal secret share. 
+
+## Using the output
+
+To generate a key package the participant requires:
+
+* The signer's identifier
+* The signer's secret share
+* The signer's public key
+* The public signing key that represents the entire group
+
+The commitment is used to verify the signer's secret share and to generate the group commitment.
+
+The dealer should use a secure broadcast channel to ensure each participant has a consistent view of this commitment and each participant must [verify the commitments](https://github.com/ZcashFoundation/frost/blob/4055cb9439df2814800c678c8da1760a0f86dc10/frost-core/src/frost/keys.rs#L297). 
+The trusted dealer MUST delete the secret_key (used during calculation) and secret_share upon completion.
+Use of this method for key generation requires a mutually authenticated secure channel between the dealer and participants to send secret key shares, wherein the channel provides confidentiality and integrity. Mutually authenticated TLS is one possible deployment option.
+
+NOTE: A signer is a participant that generates a signing share which is aggregated with the signing shares of other signers to obtain the final group signature.
+
+## Developer information
+
+### Pre-commit checks
+
+1. Run `cargo make all`
+
+### Coverage
+
+Test coverage checks are performed in the pipeline. This is configured here: `.github/workflows/coverage.yaml`
+To run these locally:
+1. Install coverage tool by running `cargo install cargo-llvm-cov`
+2. Run `cargo cov` (you may be asked if you want to install `llvm-tools-preview`, if so type `Y`)