From 7b70e7fa97401b6061ab46e1097f98c468c3a7c8 Mon Sep 17 00:00:00 2001 From: Peter Taoussanis Date: Wed, 18 Oct 2023 12:58:13 +0200 Subject: [PATCH] [new] Add initial docs (~wip) --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0aadae8..95167b4 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,9 @@ ### Data security framework for Clojure -This library is **still under development** and not available yet for public use. +**Tempel** is a lightweight encryption framework that wraps the JVM's native crypto facilities to provide a **high-level Clojure API** that is: idiomatic, simple, and **easy-to-use** even for non-experts. + +It incorporates **best practices and reasonable defaults**, and includes **detailed beginner-oriented documentation** to greatly simplify many of the most common data security needs. ## Latest release/s @@ -18,7 +20,13 @@ See [here][GitHub releases] for earlier releases. ## Why Tempel? -- Coming later +- **Easy-to-use, high-level API** focused on common encryption tasks +- Support for **symmetric** and **asymmetric** encryption +- **Reasonable defaults** including choice of algorithms and work factors +- **Future-proof data formats** with support for updated algorithms and work factors over time +- Sensible **key management API** for use in real-world applications +- Automatic **[scrypt](https://en.wikipedia.org/wiki/Scrypt) and [pbkdf2](https://en.wikipedia.org/wiki/PBKDF2) support** for password-based key stretching +- Extensive, beginner-oriented [documentation](#documentation) (work-in-progress) ## Documentation