Skip to content

Commit

Permalink
Docs: Crate level intro
Browse files Browse the repository at this point in the history
  • Loading branch information
brycx committed Nov 4, 2018
1 parent f7fd02a commit 06fbecc
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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)]
Expand Down

0 comments on commit 06fbecc

Please sign in to comment.