Add docs link to readme

This commit is contained in:
Leonetienne 2022-06-01 20:58:31 +02:00
parent 377099907b
commit 7410bc1b54
No known key found for this signature in database
GPG Key ID: C33879CD92E9708C

View File

@ -2,6 +2,9 @@
*(GhettoCrypt), because frankly I have no idea what the fuck I'm doing*
<sub>*Please don't use this for anything critical*</sub>
## [Documentation](https://gcrypt.rtfm.leonetienne.de/)
## What the hell is this?
An educational project on implementing a block cipher using a feistel network.
This block cipher employs a few modes of operation. Read more about them [here](#modes-of-operation).
@ -102,6 +105,8 @@ This way you can cipher on bitlevel. Examples on how to do this are in [GWrapper
This way you could, for example, decrypt an ecrypted file directly into memory.
Without saying, this is more advanced and not as-easy as the methods supplied in the wrapper.
Want more documentation? See the [doxygen page](https://gcrypt.rtfm.leonetienne.de/).
---
## The deets 🍝