From aed0a251d47a4830a6492cf9d3361b64af287ef7 Mon Sep 17 00:00:00 2001
From: Pascal Perrenoud <pascal@pband.ch>
Date: Tue, 4 Jun 2024 16:57:57 +0200
Subject: [PATCH] README

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..224cfc1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+Tests : ![CI status](https://ci.pband.ch/api/badges/11/status.svg "CI status")
+
+# Crypto tools
+Various crypto tools used often.  
+The lib is based as much as possible on the [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) !  
+The JWT part uses [JOSE](https://github.com/panva/jose) as it implements all the JWT functions.  
+The signature part uses [noble-ed25519](https://github.com/paulmillr/noble-ed25519) instead of the Web Crypto API, so you can derive a KeyPair from a password. 
+
+# Tools
+- JWT : Sign/Verify JWT with payload, audience and issuer
+- PBKDF : Derive password
+- Signature
+  - Generate
+  - Derive from password
+  - Sign
+  - Verify
+- boxes
+  - Private box
+  - Secret box
+  - Password box
+  - Wrapping
+    - Private
+    - Secret
+    - Password