Skip to content

update readme to show new library name #59

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
selfmadecode merged 1 commit into from
Jul 12, 2024
Merged

update readme to show new library name #59

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
15 changes: 7 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# SafeCrypt Library
# SafeEnkrypt Library

A C# library for encryption and decryption.

## Overview

The SafeCrypt library provides a set of methods for encrypting and decrypting data using various encryption algorithms,
The SafeEnkrypt library provides a set of methods for encrypting and decrypting data using various encryption algorithms,
including the Advanced Encryption Standard (AES) and RSA (Rivest–Shamir–Adleman).
It is designed to be easy to use and can be integrated into C# applications that require secure data transmission or storage.
## Table of Contents
Expand All @@ -17,13 +17,12 @@ It is designed to be easy to use and can be integrated into C# applications that

## Installation

To use the SafeCrypt library in your C# project, follow these steps:
To use the SafeEnkrypt library in your C# project, follow these steps:

1. Clone the repository:

```bash
git clone https://github.com/selfmadecode/SafeCrypt
cd SafeCrypt
git clone https://github.com/selfmadecode/SafeEnkrypt
```

2. Build the project:
Expand All @@ -32,7 +31,7 @@ To use the SafeCrypt library in your C# project, follow these steps:
dotnet build
```

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

## Aes
To use AES encryption in your C# application, access the static Aes class directly.
Expand All @@ -49,7 +48,7 @@ For more details on RSA Encryption, check the [Rsa.md](doc/Rsa.md) document.

## Contributing

If you would like to contribute to the development of the SafeCrypt library, follow these steps:
If you would like to contribute to the development of the SafeEnkrypt library, follow these steps:

1. Create an issue to discuss the proposed changes or bug fixes.
2. Fork the repository and create a new branch for your work:
Expand All @@ -65,4 +64,4 @@ If you would like to contribute to the development of the SafeCrypt library, fol

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/selfmadecode/SafeCrypt/tree/master?tab=MIT-1-ov-file) file for details.
This project is licensed under the MIT License - see the [LICENSE](https://github.com/selfmadecode/SafeEnkrypt/tree/master?tab=MIT-1-ov-file) file for details.