From e8acab9a17d312ba5ad2753446683e9ff3c272b3 Mon Sep 17 00:00:00 2001 From: Ignacio Date: Sun, 31 Mar 2024 15:33:41 -0300 Subject: [PATCH] Modified README.md --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ac1b938..a7f8f6c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,7 @@ -# salty -Salty is an encryption tool I made during my free time. Named after libsodium, its main library, it takes a file as input and encrypts it. This is my first proper project in C. +# Salty +Salty is a simple encryption tool I made during my free time, using libsodium. It takes an input and output file, along with an optional password, and encrypts or decrypts the contents. This is my first proper project in C, so the code may be a bit messy in places. +## Flags +- -in: Takes an input file. +- -out: Takes an output file. If no file is selected, or set to '-', output is /dev/stdout. +- -key: Takes a password up to 128 characters in length. +- -d: Enables decryption mode.