From 06fbecc90b180c2eb76babcacc61b2448c7c5c11 Mon Sep 17 00:00:00 2001 From: brycx Date: Sun, 4 Nov 2018 18:35:40 +0100 Subject: [PATCH] Docs: Crate level intro --- src/lib.rs | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index 6b492220..b4affe90 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -20,7 +20,14 @@ // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE // SOFTWARE. -//! Pure-Rust cryptography library. See more in the [wiki](https://github.com/brycx/orion/wiki). +//! orion - A usable pure-Rust cryptography library. +//! +//! Most functionality that you would need access to should be available through orion's `default` +//! API. This API includes authenticated secret-key encryption, password hashing and more. +//! +//! Usage of the `hazardous` module is only intended for advanced users. +//! +//! You can read more about orion in the project [wiki](https://github.com/brycx/orion/wiki). #![cfg_attr(not(feature = "safe_api"), no_std)] #![forbid(unsafe_code)] #![deny(overflowing_literals)]