diff --git a/README.md b/README.md index 60dca6b..81284da 100644 --- a/README.md +++ b/README.md @@ -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