From 27c0978deada8abcbf0997a52c0f92e820df36a1 Mon Sep 17 00:00:00 2001 From: TQ Hirsch Date: Mon, 11 Feb 2019 15:26:52 +0100 Subject: [PATCH] Start writing docs --- README.md | 19 +++++++++++++++++++ src/main.rs | 2 +- 2 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f27a39c --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +RSSSS — Rust Shamir Secret Sharing Scheme +=================================== + +This is an implementation of Shamir's secret sharing scheme, useful +for securely dividing a secret into parts, some number of which must +be present to recover the original secret. + +Principle of Operation +---------------------- + +Shamir's secret sharing scheme (S4) works by + +Installation +------------ + + cargo install rssss + +Usage +----- \ No newline at end of file diff --git a/src/main.rs b/src/main.rs index 0c7fefc..0c846fb 100644 --- a/src/main.rs +++ b/src/main.rs @@ -52,7 +52,7 @@ use std::io; /// M34: (~1.2MBit) 2^1257787-1 /// /// M19 should only be used for *extremely* secure sharing of RSA keys; M34 -/// probably shouldn't be used at all. It will likely be extremely slow; +/// probably shouldn't be used at all. It will likely be unusably slow; /// you should rather generate shares of an AES key and use that to encrypt your real secret #[derive(StructOpt)]