README: update

2026-09-24 17:23:30 +02:00
parent 03aee796d8
commit 389a059fee
1 changed files with 18 additions and 0 deletions
@@ -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>
+```