Skip to content

Update README.md #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jochengehtab merged 1 commit into from
Mar 24, 2025
Merged

Update README.md #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@
# RSA-Encryptor
# RSA Encryptor

# Roadmap
## Overview

- [ ] Get informed about RSA
- [ ] Write utility functions
- [ ] Implement Encryption
- [ ] Implement Decryption
- [ ] Add Tests
**RSA Encryptor** is a simple RSA encryption and decryption library written in C++. It implements its own routines for handling large numbers using base-256 representation and is released under the [AGPL License](https://www.gnu.org/licenses/agpl-3.0.html).
> [!NOTE]
> This project uses `clang-format 20` for code formatting and is built and tested on macOS, Windows, and Ubuntu.

## License

RSA Encryptor is distributed under the [AGPL License](https://www.gnu.org/licenses/agpl-3.0.html). See the `LICENSE` file for more details.

## Contact

For issues, please open an issue on the GitHub repository or contact the maintainers directly under this email mail@parallelengineering.org.

## Roadmap
- [x] Get informed about RSA
- [x] Write utility functions
- [x] Add workflows
- [ ] Implement encryption
- [ ] Implement decryption
- [ ] Beautify CLI output