diff --git a/README.md b/README.md index 4306723..89062d2 100644 --- a/README.md +++ b/README.md @@ -1,80 +1,40 @@ > " Freedom of speech is not just a right; it's a cornerstone of democracy. In its purest form, it allows ideas to clash, perspectives to evolve, and societies to progress. Yet, with this great power comes the responsibility to navigate the delicate balance between expression and respect. How do we safeguard this essential freedom while fostering a culture of inclusivity and understanding? " +> +

+ +

+# ChatGuard -# Chat Guard +Simple and easy to use browser extension that allow end to end encryption on [telegram/k](https://telegram.com/k), [telegram/a](https://telegram.com/a), [twitter](https://twitter.com), [bale](https://web.bale.ai/chat) ,[soroush](https://web.splus.ir/), [eitaa](https://web.eitaa.com/) +### ChatGuard is a global solution to make almost any standard web messenger to be end to end encrypted -Chat Guard is browser Extension allow to have end to end encrypted conversation in almost any platform you want +## How to use Chat Guard ? -Welcome to Chat Guard for. This guide will walk you through the steps to download and install the Chat Guard on various browsers and devices. +1. Download and install the extension with [official documentation](https://chat-guard.vercel.app/getting-started/installation) -## Chrome +1. Open one of the [supported messenger](https://chat-guard.vercel.app/getting-started/support) +1. Both user must use the action menu and click to the "Create Handshake" to initiate a encryption handshake +1. After the handshake complete successfully, you can enjoy a safe chat :) -### From the Official Chrome Web Store +## How Chat Guard encrypt the messages? -[![chrome store](./docs/public/images/chromeStore.svg)](https://chromewebstore.google.com/) +- We use hybrid (Symmetric and Asymmetric) encryption +- first both user initiate a handshake, the handshake contain user public key +- after the handshake, when each user want to send a message this proccess take place : -1. Open [Chrome Web Store](https://chrome.google.com/webstore). +1. generate a secret key +2. encrypt the secret key with both public keys +3. encrypted the message with the secret key +4. append the encrypted secret keys and encrypted message to one singular message and send it to the user -2. Click on the "Add to Chrome" button. +#### Now other user can decrypt the secret key with their own private key and using the decrypted secret key, user can decrypt the actual message -### Sideload Extension (Using the Extension File) +## Donation -1. Download the extension file (usually a .zip or .crx file) from [download page](https://github.com/PrivacyForge/ChatGuard/releases/tag/v0.5.3-beta). +I appreciate every donation for this project +every donation will be spend on growing the project and releasing it on different platform like safari, etc. -2. Open Chrome and go to `chrome://extensions/`. - -3. Enable "Developer mode" at the top-right corner. - -4. Click "Load unpacked" and select the folder containing the extension files. - -## Firefox - -### From the Official Mozilla Add-ons - -[![firefox store](./docs/public/images/firefoxStore.svg)](https://addons.mozilla.org/en-US/firefox/) - -1. Open [Mozilla Add-ons](https://addons.mozilla.org/). - -2. Search for "[Your Browser Extension Name]". - -3. Click on "Add to Firefox". - -### Sideload Extension (Using the Extension File) - -1. This feature is not working anymore, so use the official store to install the extension. - -## Safari - -### From the Official Safari Extension Gallery - -[![apple app store](./docs/public/images/appleStore.svg)](https://safari-extensions.apple.com/) - -1. Open [Safari Extensions](https://safari-extensions.apple.com/). - -2. Click "Install Now". - -### Sideload Extension (Using the Extension File) - -1. This feature is not working anymore, so use the official store to install the extension. - -## Mobile Browsers - -### Android (Kiwi Browser) - -1. Open Kiwi Browser on your mobile device. - -2. Visit the Chrome Web Store and search for "Chat Guard". - -3. Tap "Add to Chrome". - -### iOS (Safari) - -1. Open Safari on your iOS device. - -2. Go to the [official Safari Extensions](https://apps.apple.com/us/developer/apple-inc/id284417353). - -3. Search for "Chat Guard". - -4. Tap "Get" to download and install the extension. +