diff options
author | Артём Павлов [Artyom Pavlov] <newpavlov@gmail.com> | 2017-08-13 04:31:01 +0300 |
---|---|---|
committer | Артём Павлов [Artyom Pavlov] <newpavlov@gmail.com> | 2017-08-13 04:31:01 +0300 |
commit | 47d4d2f3997561021a127894cbf5c1f112ec6ed3 (patch) | |
tree | 97bc66607d29bc5a82ef5ea92fc4054c577f5d65 | |
parent | 524afa4d45cab903bc755fb531fd5d11cd73eee2 (diff) | |
download | PAKEs-47d4d2f3997561021a127894cbf5c1f112ec6ed3.tar.xz |
Docs update
-rw-r--r-- | Cargo.toml | 2 | ||||
-rw-r--r-- | src/lib.rs | 17 |
2 files changed, 18 insertions, 1 deletions
@@ -1,6 +1,6 @@ [package] name = "srp" -version = "0.1.0" +version = "0.1.1" authors = ["RustCrypto Developers"] license = "MIT/Apache-2.0" description = "Secure Remote Password (SRP) protocol implementation" @@ -8,6 +8,23 @@ //! //! Currently compatability with over implementations was not tested. //! +//! # Usage +//! Add `srp` dependecy to your `Cargo.toml`: +//! +//! ```toml +//! [dependencies] +//! rand = "0.3" +//! ``` +//! +//! and this to your crate root: +//! +//! ```rust +//! extern crate srp; +//! ``` +//! +//! Next read documentation for [`client`](client/index.html) and +//! [`server`](server/index.html) modules. +//! //! # Algorithm description //! Here we briefly describe implemented algroithm. For additionall information //! refer to SRP literature. All arithmetic is done modulo `N`, where `N` is a |