Skip to content

Commit

Permalink
[new] Add initial docs (~wip)
Browse files Browse the repository at this point in the history
  • Loading branch information
ptaoussanis committed Oct 18, 2023
1 parent 8739d7b commit 7b70e7f
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down

0 comments on commit 7b70e7f

Please sign in to comment.