Feature/#163 documentation enhancement #165
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Introduced `Program.cs` to demonstrate DSA and AES examples. - Added test files for AES and RSA examples including `.docx`, `.pdf`, `.png`, and `.xlsx`. - Updated `CryptoNet.ExtPack` project to improve MD5 calculation and string comparison. - Modified solution file to include the new `CryptoNet.Examples` project. - Removed outdated contributing guidelines from `README.md`. - Deleted `RELEASE-NOTES` file as it was no longer needed. - Created various PowerShell scripts for build, code coverage, Docker setup, documentation generation, and NuGet validation. - Added migration guide for transitioning from CryptoNet v2.4.0 to v3.4.3, detailing breaking changes and updates. - Updated table of contents in documentation to include migration and examples sections.
Added `Example_6_Wokring_With_Special_Character_Text` to demonstrate encryption and decryption of text with special characters (e.g., emojis) using UTF-8 encoding. Updated `Program.cs` to include the new example and re-enable previously commented-out AES and RSA examples. Modified `BytesToString` and `StringToBytes` in `ExtShared.cs` to use UTF-8 encoding instead of ASCII for better handling of non-ASCII characters. Updated `migration.md` with a TODO note about encrypting strings with special characters and suggested using byte arrays for clarity.
Refactored example methods to use PascalCase, added XML comments, and improved variable naming for clarity. Standardized key management APIs across AES, DSA, and RSA examples. Enhanced file encryption examples to support arbitrary file types. Updated documentation with detailed examples, migration guides, and a new `tooling.md` for developer workflows. Improved CI/CD documentation and reusable workflow examples in `CONTRIBUTING.md`. Added support for special characters in encryption examples and advanced PEM operations. Updated project structure to include a "Docs" project and additional documentation files. Enhanced code readability, consistency, and developer experience.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new
CryptoNet.Examplesproject targeting .NET 10.0, along with comprehensive example code for AES and DSA cryptographic operations. It also adds detailed project instructions and contribution guidelines, and makes minor formatting improvements to documentation. The most significant changes are the addition of practical usage examples for the CryptoNet library, which will help users and contributors understand and test core cryptographic functionalities.New Example Project and Usage Samples:
CryptoNet.Examplesproject (CryptoNet.Examples.csproj) targeting .NET 10.0, including references to the main CryptoNet package and test files for demonstration purposes.ExampleAes.cswith multiple static methods demonstrating AES encryption/decryption scenarios: generating and saving keys, using raw or human-readable keys, and encrypting/decrypting files. Includes helper methods and data validation.ExampleDsa.cswith static methods showing DSA signing and verification, including generation, saving/loading of key pairs, and signature validation.Documentation and Contribution Guidelines:
.github/copilot-instructions.md, a detailed instruction manual covering project architecture, development workflows, coding conventions, migration guides, and common pitfalls for contributors and AI coding agents.CONTRIBUTING.mdfile with a new "Contributing" section, outlining ways to contribute and providing a resource link for new contributors.Documentation Formatting Improvements:
CONTRIBUTING.mdfrom triple backticks withyamlto triple tildes for consistency and improved rendering. [1] [2] [3]These changes collectively enhance the usability, maintainability, and accessibility of the CryptoNet library for both users and contributors.