diff --git a/Cargo.toml b/Cargo.toml index c21518f..d710d2b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "simple_rsa" +name = "simple_crypto" version = "0.1.0" authors = ["Adam Wick "] description = "A simple crypto library for Rust." diff --git a/src/lib.rs b/src/lib.rs index 4566d3b..28732ae 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,22 @@ +//! # Simple Crypto: A quaint little crypto library for rust. +//! +//! This is the simple_crypto library. Its goal is to provide straightforward +//! coverage of most of the common cryptographic algorithms used today, along +//! with simplified interfaces for new users. If you see something that's +//! unclear, please point it out! We can always use documentation help. +//! +//! This main library will eventually provide most of the convenience functions +//! that a new user should use, along with documentation regarding how and +//! when they should use it, and examples. For now, it mostly just fowards +//! off to more detailed modules. Help requested! + +#[cfg(test)] +#[macro_use] +extern crate quickcheck; + +/// The cryptonum module provides support for large numbers at fixed, +/// cryptographically-relevant sizes. +pub mod cryptonum; #[cfg(test)] mod test {