Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hakavlad committed Feb 6, 2024
1 parent 2f43b67 commit 704316b
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
- Argon2 memory-hard function for key stretching and key derivation.
- ChaCha20-IETF cipher for data encryption.

## Cryptoblob structure
## Encryption format (cryptoblob) structure
```
512B 0+B
+----------+---------------+
Expand Down Expand Up @@ -75,8 +75,8 @@ Just run the script, select the option you want and then answer the questions.
## Requirements

- Python >= 3.6
- PyNaCl >= 1.2.0 (provides `Argon2` KDF)
- PyCryptodomex >= 3.6.2 (provides `ChaCha20` cipher)
- [PyNaCl](https://pypi.org/project/PyNaCl/) >= 1.2.0 (provides `Argon2` KDF)
- [PyCryptodomex](https://pypi.org/project/pycryptodomex/) >= 3.6.2 (provides `ChaCha20` cipher)

## Install

Expand All @@ -87,6 +87,8 @@ $ pip install tird

Binary builds (made with [PyInstaller](https://pyinstaller.org/en/stable/)) are also available (see [Releases](https://github.com/hakavlad/tird/releases)).

![tird.exe](https://i.imgur.com/84SzDDy.png)

## TODO

Write documentation.
Expand Down

0 comments on commit 704316b

Please sign in to comment.