Modified README.md

This commit is contained in:
Ignacio 2024-03-31 15:33:41 -03:00
parent 1960dc999e
commit e8acab9a17

View File

@ -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.