Merge pull request #4 from tasnimzotder/dev

Add Public Key Sharing & File Save Features

Author: tasnimzotder

.gitignore

@@ -118,3 +118,4 @@ bin
 
 acme.json
 .env
+.vscode

.idea/inspectionProfiles/Project_Default.xml

@@ -1,25 +1,43 @@
 # tChat
 
-Terminal chat application for developers
+Terminal chat application for developers. Share texts and files between users (or servers) using end-to-end encryption.
 
 ## Features
 
-- [x] Send text messages 
-- [ ] Send files and images
+- [x] Send text messages
+- [x] Send files
 - [ ] Secure authentication
-- [ ] End-to-end encryption
+- [x] End-to-end encryption
 - [ ] Live chat
 
+## Working
+
+### Public Key Sharing
+
+![Public Key Sharing Sequence Diagram](./assets/pubkey-sharing-seq-diagram.png)
+
+### End-to-end Encryption
+
+![End-to-end Encryption Sequence Diagram](./assets/e2ee-seq-diagram.png)
+
 ## Installation
 
 Git clone the repository and run the following commands:
 
+1. For Mac and Linux:
+
 ```bash
 sudo sh install.sh
 ```
 
 This will build the application and copy the executable to /usr/local/bin directory.
 
+2. For Windows: (using PowerShell)
+
+```bash
+.\install.ps1
+```
+
 ## Usage
 
 To start the application, run the following command:
@@ -28,23 +46,32 @@ To start the application, run the following command:
 tchat
 ```
 
-Please run the following command to register your username:
+Please run the following command to start a new connection:
 
 ```bash
-tchat init -u <username>
+tchat conn
 ```
 
 ## Commands
 
-| Command | Description            | Example                                  |
-|---------|------------------------|------------------------------------------|
-| init    | Register your username | `tchat init -u <username>`               |
-| s       | Send a message         | `tchat send -r <recipient> -m <message>` |
-| m       | Message                | `tchat m`                                |
+| Command | Description              | Example                                 |
+| ------- | ------------------------ | --------------------------------------- |
+| `conn`  | Start or save connection | `tchat conn`                            |
+| `msg`   | Receive messages         | `tchat msg -d 1 -s hello.txt`           |
+| `send`  | Send messages            | `tchat send -r <receiver> -m <message>` |
 
 ### Message Command
 
-| Option | Description      | Example          |
-|--------|------------------|------------------|
-| -c     | Clear the chat   | `tchat m -c all` |
-| -d     | Display the chat | `tchat m -d 10`  |
+| Option | Description                      | Example                       |
+| ------ | -------------------------------- | ----------------------------- |
+| -c     | Clear the messages               | `tchat msg -c all`            |
+| -d     | Display a message (serialNumber) | `tchat m -d 2`                |
+| -s     | Save a message to file           | `tchat msg -d 2 -s hello.txt` |
+
+### Send Command
+
+| Option | Description | Example                                 |
+| ------ | ----------- | --------------------------------------- |
+| -r     | Receiver    | `tchat send -r <receiver> -m <message>` |
+| -m     | Message     | `tchat send -r <receiver> -m <message>` |
+| -f     | File        | `tchat send -r <receiver> -f <file>`    |

README.md

@@ -150,3 +150,5 @@ go.work
 # Android studio 3.1+ serialized cache file
 
 .env.*
+.vscode
+.idea