Skip to content

Commit f0be2e2

Browse files
author
Levent KARAGÖL
committed
Code structure has been revised
1 parent 027d938 commit f0be2e2

File tree

2 files changed

+213
-302
lines changed

2 files changed

+213
-302
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ target_link_libraries(myProject PRIVATE libcpp-crypto OpenSSL::SSL OpenSSL::Cryp
5151

5252
## How to use? (Symmetric Encryption with AES)
5353

54-
To encrypt and decrypt the given text with AES-256, all you need to do is call the static **"encryptWithAES"** and
55-
**"decryptWithAES"** methods with a key you choose for encryption.
54+
To encrypt and decrypt the given text with AES-256, all you need to do is call the **"encryptWithAES"** and
55+
**"decryptWithAES"** functions with a key you choose for encryption.
5656

5757
```cpp
5858
#include "libcpp-crypto.hpp"
@@ -83,7 +83,7 @@ int main() {
8383
8484
## How to use? (Hash with SHA-256)
8585

86-
All you need to do is call the static **"hash"** method to hash the given text with SHA-256.
86+
All you need to do is call the **"hash"** function to hash the given text with SHA-256.
8787

8888
```cpp
8989
#include "libcpp-crypto.hpp"
@@ -104,8 +104,8 @@ int main() {
104104

105105
## How to use? (Asymmetric Encryption with RSA)
106106

107-
To encrypt and decrypt the given text with RSA, all you need to do is call the static **"encryptWithRSA"** and
108-
**"decryptWithRSA"** methods with a pair of public/private key.
107+
To encrypt and decrypt the given text with RSA, all you need to do is call the **"encryptWithRSA"** and
108+
**"decryptWithRSA"** functions with a pair of public/private key.
109109

110110
> [!TIP]
111111
> If you don't know how to generate public/private keys, please see the next topic
@@ -332,22 +332,21 @@ section to the documentation.
332332

333333
## Full function list
334334

335-
You can find the complete list of functions in the library below. All methods in this library are static methods.
336-
You don't need to create an instance of the class to use them.
335+
You can find the complete list of functions in the library below.
337336

338337
> [!TIP]
339-
> All methods and parameters descriptions are also available within the code as comment for IDEs.
338+
> All functions and parameters descriptions are also available within the code as comment for IDEs.
340339
341340
```cpp
342-
static std::string encryptWithAES(const std::string& plaintext, const std::string& key);
341+
std::string encryptWithAES(const std::string& plaintext, const std::string& key);
343342

344-
static std::string decryptWithAES(const std::string& ciphertext, const std::string& key);
343+
std::string decryptWithAES(const std::string& ciphertext, const std::string& key);
345344

346-
static std::string encryptWithRSA(const std::string& plaintext, const std::string& publicKeyStr);
345+
std::string encryptWithRSA(const std::string& plaintext, const std::string& publicKeyStr);
347346

348-
static std::string decryptWithRSA(const std::string& ciphertext, const std::string& privateKeyStr);
347+
std::string decryptWithRSA(const std::string& ciphertext, const std::string& privateKeyStr);
349348

350-
static std::string hash(const std::string& text);
349+
std::string hash(const std::string& text);
351350
```
352351
353352
## License

0 commit comments

Comments
 (0)