From 932ba3bfebb497c27d0fdf4a69a6d239d3f2b48a Mon Sep 17 00:00:00 2001
From: Avril <flanchan@cumallover.me>
Date: Tue, 25 Aug 2020 23:59:13 +0100
Subject: [PATCH] small readme

---
 Cargo.toml |  2 ++
 README.md  | 18 ++++++++++++++++++
 src/lib.rs | 19 ++++++++++++++++---
 3 files changed, 36 insertions(+), 3 deletions(-)
 create mode 100644 README.md

diff --git a/Cargo.toml b/Cargo.toml
index 67a344f..9a665c5 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,8 @@
 [package]
 name = "cryptohelpers"
 version = "0.1.0"
+license= "mit"
+description = "Collection of helpers and simplifying functions for cryptography things"
 authors = ["Avril <flanchan@cumallover.me>"]
 edition = "2018"
 
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0777ec0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# cryptohelpers
+
+Collection of helpers and simplifying functions for cryptography things.
+All modules are feature gated.
+
+* sha256 - `sha256` feature
+* password - `password` feature
+* aes - `aes` feature
+* crc - `checksum` feature
+* rsa - `rsa` feature
+
+There is also `full` for enabling them all.
+
+## Async processing
+The `async` feature adds asynchronous streaming functions with Tokio's `AsyncRead` and `AsyncWrite` traits.
+
+# License
+MIT
diff --git a/src/lib.rs b/src/lib.rs
index 10712fd..cede6a3 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,11 +1,25 @@
+//! Collection of helpers for cryptography things.
+//! All modules are feature gated.
+//!
+//! * sha256 - `sha256` feature
+//! * password - `password` feature
+//! * aes - `aes` feature
+//! * crc - `checksum` feature
+//! * rsa - `rsa` feature
+//!
+//! There is also `full` for enabling them all.
+//!
+//! # Async processing
+//! The `async` feature adds asynchronous streaming functions with Tokio's `AsyncRead` and `AsyncWrite` traits.
+
 #![allow(dead_code)]
 
 pub mod consts;
 #[allow(unused_imports)]
 use consts::*;
 
-pub mod util;
-pub mod bytes;
+mod util;
+mod bytes;
 
 #[allow(unused_imports)]
 mod error;
@@ -20,6 +34,5 @@ pub mod password;
 pub mod aes;
 #[cfg(feature="checksum")]
 pub mod crc;
-
 #[cfg(feature="rsa")]
 pub mod rsa;