aboutsummaryrefslogtreecommitdiff
path: root/lockchain-core/README.md
diff options
context:
space:
mode:
authorKatharina Fey <kookie@spacekookie.de>2018-05-06 20:19:53 +0200
committerKatharina Fey <kookie@spacekookie.de>2018-05-06 20:19:53 +0200
commit3488a2ed44d751fbbb84a588bd2b1f1f7b8f58ca (patch)
tree88510f790377b93cf8b99e2a0e6638b16d17353a /lockchain-core/README.md
parentff07b004c16939c86ac89a4d25b3ca1e243b172e (diff)
Massively refactor repository
Diffstat (limited to 'lockchain-core/README.md')
-rw-r--r--lockchain-core/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/lockchain-core/README.md b/lockchain-core/README.md
index 32ebc7c..b79c82d 100644
--- a/lockchain-core/README.md
+++ b/lockchain-core/README.md
@@ -1,5 +1,11 @@
# lockchain-core
+This library ecosystem is made of three main parts.
+
+ - `lockchain-core` Common types shared between both `secret` and `default` operation modes.
+ - `lockchain-files` load vaults, decode files and work with encrypted streams.
+ - `lockchain-crypto` attach crypto handlers to vaults as a middleware to decrypt data.
+
If you're a Rust developer and interested in the `lockchain` crate, this README is for you. Lockchain is a document based, encrypted data vault. It provides you with an easy to use API to create, manage and update vaults and records. Build robust and user-friendly applications that deal with their data in a secure manner.
Most notibly, this crate is being used by the [lockchain]() password manager as well as the [poke]() linux ssh key manager.