Basic documentation.

Closes #1.
This commit is contained in:
Frederic Jacobs
2016-04-07 02:01:40 +02:00
parent 2806bc49bc
commit a52bf5fff1
4 changed files with 52 additions and 11 deletions

View File

@ -1,4 +1,6 @@
# Rusty Secrets ![Travis-Badge](https://travis-ci.org/freedomofpress/RustySecrets.svg) [![Coverage Status](https://coveralls.io/repos/github/freedomofpress/RustySecrets/badge.svg?branch=master)](https://coveralls.io/github/freedomofpress/RustySecrets?branch=master)
# Rusty Secrets [![Build Status](https://travis-ci.org/freedomofpress/RustySecrets.svg?branch=master)](https://travis-ci.org/freedomofpress/RustySecrets) [![Coverage Status](https://coveralls.io/repos/github/freedomofpress/RustySecrets/badge.svg?branch=master)](https://coveralls.io/github/freedomofpress/RustySecrets?branch=master)
[**Documentation**](http://freedomofpress.github.io/RustySecrets/rusty_secrets/index.html)
Rusty Secrets is an implementation of a threshold [Shamir's secret sharing scheme](https://en.wikipedia.org/wiki/Shamir%27s_Secret_Sharing).
@ -65,10 +67,6 @@ $ echo -e "2-2-YJZQDGm22Y77Gw \n 2-4-F7rAjX3UOa53KA" | ./rusty_secrets_bin -d
My secret
```
### Library
Documentation to come for the library interface.
## Vocabulary
- Dealer: Entity that will perform key splitting from a master secret