From 389a059fee78d0325d2042cd69c283aace0966f6 Mon Sep 17 00:00:00 2001
From: Sam Hadow <sam.hadow@proton.me>
Date: Thu, 24 Sep 2026 17:23:30 +0200
Subject: [PATCH] README: update

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index e69de29..0d9384f 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,18 @@
+# filecrypt-rs
+
+Cli tool in Rust to encrypt and decrypt files with an Ascon-Keccak AEAD.  
+The PBKDF is not yet implemented and is just SHA256(password) for now
+
+## Commands
+
+### Encrypt a file
+
+```bash
+filecrypt-rs encrypt --input <FILE> --output <FILE> --password <PASSWORD>
+```
+
+### Decrypt a file
+
+```bash
+filecrypt-rs decrypt --input <FILE> --output <FILE> --password <PASSWORD>
+```