From dbcc7b769d57748d7ce04353b004362ff774b0a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Levent=20KARAG=C3=96L?= Date: Sun, 19 May 2024 13:44:31 +0300 Subject: [PATCH] Documentation has been updated --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fcfab75..b5c3df1 100644 --- a/README.md +++ b/README.md @@ -46,8 +46,8 @@ target_link_libraries(myProject PRIVATE libcpp-crypto OpenSSL::SSL OpenSSL::Cryp ## How to use? (Symmetric Encryption with AES) -To encrypt and decrypt the given text with AES-256, all you need to do is call the static "encryptWithAES" and -"decryptWithAES" methods with a key you choose for encryption. +To encrypt and decrypt the given text with AES-256, all you need to do is call the static **"encryptWithAES"** and +**"decryptWithAES"** methods with a key you choose for encryption. ```cpp #include "libcpp-crypto.hpp" @@ -79,9 +79,9 @@ int main() { ## How to handle Exceptions? -There are two main Exceptions you may encounter when using the library. The first one is the "InvalidKeyException" +There are two main Exceptions you may encounter when using the library. The first one is the **"InvalidKeyException"** you will receive if the encryption key of the text you want to decrypt is incorrect, and the second one is the -"CorruptedTextException" you will receive if the text you want to decrypt is invalid. +**"CorruptedTextException"** you will receive if the text you want to decrypt is invalid. The code below shows you how to catch the Exception thrown in case of an invalid encryption key.