Skip to content

Commit 71a61f5

Browse files
committed
feat: update readme documentation
1 parent d6f76c4 commit 71a61f5

2 files changed

Lines changed: 11 additions & 21 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ class Program
7272
}
7373

7474

75-
75+
-------------------------------------------------------------------------------------------------------
7676

7777
using SafeCrypt.AESDecryption;
7878
using SafeCrypt.AESEncryption;
@@ -82,7 +82,7 @@ class Program
8282
{
8383
static void Main()
8484
{
85-
var dataToEncrypt = "Data to Ebcrypt";
85+
var dataToEncrypt = "Data to Encrypt";
8686

8787
var iv = "gyrthusdgythisdg";
8888
var secret = "hghjuytsdfraestwsgtere==";

SafeCrypt.csproj

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -15,37 +15,27 @@
1515
<PackageReadmeFile>README.md</PackageReadmeFile>
1616
<PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
1717
<PackageLicenseFile>MitLicense.txt</PackageLicenseFile>
18-
<PackageReleaseNotes>SafeCrypt Library - Release Notes
18+
<PackageReleaseNotes>SafeCrypt Library - Release Notes - Version 1.0.1
1919

20-
Version 1.0.0
20+
This release (version 1.0.1) includes updates to the documentation and namespace changes. We have improved the README document to provide more comprehensive information about the library and made adjustments to the namespaces for better organization.
2121

22-
Highlights:
23-
- New Features:
24-
- `EncryptToHexString`: Easily encrypt data with a hexadecimal string output.
25-
- `DecryptFromBase64String`: Decrypt Base64-encoded string data with validation.
26-
- `GenerateAesKey`: Generate a random AES key of a specified size.
22+
Changes
2723

28-
- Improvements:
29-
- Enhanced validation checks for input parameters in encryption and decryption methods.
30-
- Improved error handling for decryption, including padding errors.
24+
- Updated README document with detailed usage instructions, API references, and contribution guidelines.
25+
- Made changes to namespaces for better organization and clarity in the codebase.
3126

32-
- Bug Fixes:
33-
- Resolved issues related to padding errors during decryption.
27+
Bug Fixes
3428

35-
- Documentation:
36-
- Updated and expanded the README file for better understanding and usage instructions.
37-
- Added XML documentation comments to improve code documentation.
38-
39-
- Security:
40-
- Improved key validation to ensure secure encryption and decryption.
29+
No bug fixes in this release.
4130

4231
Upgrade Command:
43-
dotnet add package SafeCrypt --version 1.0.0
32+
dotnet add package SafeCrypt --version 1.0.1
4433

4534
Feedback and Contributions:
4635
We appreciate your feedback and contributions! If you encounter any issues or have suggestions, please create an issue on GitHub: https://github.com/selfmadecode/SafeCrypt/issues
4736

4837
Thank you for using the SafeCrypt Library!</PackageReleaseNotes>
38+
<Version>1.0.1</Version>
4939
</PropertyGroup>
5040

5141
<ItemGroup>

0 commit comments

Comments
 (0)