Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dogukansahil committed Jul 6, 2024
1 parent a13923d commit 21e1908
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Welcome to BruteCipher, a simple and secure encryption tool inspired by historic
- Encrypt and decrypt text using a robust algorithm
- Easy-to-use interface
- Secure key management
- No external CDN dependencies
- All operations are performed locally in your browser using HTML, JavaScript, and CSS

## Installation

Expand All @@ -25,6 +27,31 @@ Welcome to BruteCipher, a simple and secure encryption tool inspired by historic
2. Provide the necessary keys.
3. Click on the "Encrypt" or "Decrypt" button to see the result.

## Extended Description

BruteCipher aims to provide a user-friendly and secure way to manage text encryption and decryption without relying on external services or CDNs. All operations are performed locally in your browser using HTML, JavaScript, and CSS, ensuring that your data remains private and secure.

### Key Features

- **Local Processing**: All encryption and decryption processes occur locally within your browser, meaning your data is never shared with external servers.
- **Robust Algorithm**: Utilizes a double hashing algorithm for enhanced security, inspired by the historical figure Brutus.
- **Secure Key Management**: Manage your encryption keys securely within your browser.
- **User-Friendly Interface**: Simple and intuitive interface for easy encryption and decryption.

### How It Works

- **Double Hashing Algorithm**: The algorithm applies two rounds of hashing to the input text, with each round using a different key. This makes it significantly harder for unauthorized parties to decrypt the data without the correct keys.
- **Key Management**: Users can generate and store their keys locally, ensuring that sensitive information is not exposed to external threats.
- **Passphrase Protection**: A 4-digit passphrase can be used to export and import keys, adding an extra layer of security and convenience.

### Future Plans

We are continuously working on enhancing BruteCipher. Future updates will include:
- Improved user interface
- Enhanced security features
- Support for more complex encryption algorithms
- Integration with local password storage systems

## Important Notice

**Warning:** This is a beta version. Do not use BruteCipher for important or sensitive information at this stage. We recommend waiting for the stable release for critical use cases.
Expand All @@ -37,3 +64,6 @@ We welcome contributions! Please fork this repository and submit pull requests t

This project is open source and available under the [MIT License](LICENSE).

## Contact

For any questions or feedback, feel free to contact us at [your-email@example.com](mailto:your-email@example.com).

0 comments on commit 21e1908

Please sign in to comment.