Skip to content

Commit 3282f50

Browse files
committed
feat: update readme doc
1 parent 96107e9 commit 3282f50

2 files changed

Lines changed: 13 additions & 14 deletions

File tree

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@ A C# library for encryption and decryption.
44

55
## Overview
66

7-
The Encryption library provides a set of methods for encrypting and decrypting data using the Advanced Encryption Standard (AES) algorithm, and other algorithm. It is designed to be easy to use and can be integrated into C# applications that require secure data transmission or storage.
8-
7+
The SafeCrypt library provides a set of methods for encrypting and decrypting data using various encryption algorithms,
8+
including the Advanced Encryption Standard (AES) and RSA (Rivest–Shamir–Adleman).
9+
It is designed to be easy to use and can be integrated into C# applications that require secure data transmission or storage.
910
## Table of Contents
1011

1112
- [Installation](#installation)
12-
- [Usage](#usage)
13-
- [API Reference](#api-reference)
14-
- [Examples](#examples)
15-
- [RSA Encryption and Decryption](#rsa)
13+
- [AES usage](#usage)
14+
- [RSA Encryption and Decryption usage](#rsa)
1615
- [Contributing](#contributing)
1716
- [License](#license)
1817

@@ -35,9 +34,10 @@ To use the SafeCrypt library in your C# project, follow these steps:
3534

3635
Now, you can reference the SafeCrypt library in your C# project.
3736

38-
## Basic Usage
37+
## Usage
3938

40-
To use the library in your C# application, instantiate the `AesEncryption` or `AesDecryption` class and call the provided methods. Here's a simple example:
39+
To use the AES encryption in your C# application,
40+
instantiate the `AesEncryption` or `AesDecryption` class and call the provided methods. Here's a simple example:
4141

4242
```csharp
4343
using SafeCrypt.AESDecryption;
@@ -122,7 +122,12 @@ class Program
122122
}
123123
}
124124
```
125+
126+
125127
## Rsa
128+
This library provides a straightforward implementation of RSA encryption and decryption in C# using the .NET `RSACryptoServiceProvider`.
129+
It includes methods for generating RSA key pairs, encrypting data with a public key, and decrypting data with a private key.
130+
126131
For more details on RSA Encryption, check the [Rsa.md](../doc/Rsa.md) document.
127132

128133

SafeCrypt.sln

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SafeCrypt", "src\SafeCrypt.
1313
EndProject
1414
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SafeCrypt.App", "src\SafeCrypt.Test\SafeCrypt.App.csproj", "{DAD7FFA3-AABC-47FF-BA79-0C9531BFBBE6}"
1515
EndProject
16-
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "doc", "doc", "{632FAE12-6DE3-4B21-ADBB-F5222B35F707}"
17-
ProjectSection(SolutionItems) = preProject
18-
Rsa.md = Rsa.md
19-
EndProjectSection
20-
EndProject
2116
Global
2217
GlobalSection(SolutionConfigurationPlatforms) = preSolution
2318
Debug|Any CPU = Debug|Any CPU
@@ -41,7 +36,6 @@ Global
4136
{1D91E775-F63F-4537-B81E-B8F9A6480D6D} = {0B7C0C60-9850-4554-AF85-86C0378B6B16}
4237
{AE9FAE54-9854-4F98-A60F-19125CEAA3A8} = {8507D130-9F07-426C-8EE6-0AC714CF72E5}
4338
{DAD7FFA3-AABC-47FF-BA79-0C9531BFBBE6} = {1D91E775-F63F-4537-B81E-B8F9A6480D6D}
44-
{632FAE12-6DE3-4B21-ADBB-F5222B35F707} = {0B7C0C60-9850-4554-AF85-86C0378B6B16}
4539
EndGlobalSection
4640
GlobalSection(ExtensibilityGlobals) = postSolution
4741
SolutionGuid = {639A4359-2BA4-4F71-9EBF-D6EAB68C84CB}

0 commit comments

Comments
 (0)