Skip to content

Commit fe49a8e

Browse files
Update README.md
1 parent e77fecd commit fe49a8e

File tree

1 file changed

+33
-22
lines changed

1 file changed

+33
-22
lines changed

README.md

Lines changed: 33 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,18 @@
22
This Software is designed to encrypt a Client's textfile and send it over a network socket to a Host for decryption and storage
33

44
# Usage
5-
## Client
6-
#### Saving your data
7-
To begin using this software to encrypt a message, save your desired data as a text file in:
8-
```
9-
./client/Message/Message_to_encrypt.txt
10-
```
11-
#### IP Address
12-
Upon usage, the Client will be prompted to enter the Host's IP Address
5+
## Host
6+
#### Port Number
7+
The Host must also enter a port number for the network
138

14-
The Host will have their IP Address printed to the screen for self reference
9+
The Host must communicate this number, as well as his/ her IP Address to the Client
1510

1611
For example:
1712
```
18-
Enter Host IP Address: 192.168.0.19
19-
```
20-
#### Running to Software
21-
The Client must run 'ClientGUI.py'
22-
This can be done by running the following while in the project root:
23-
``` bash
24-
$ ./scripts/run_client.sh
13+
Enter port number: 1234
2514
```
26-
The Client may then choose to encrypt and send their message to the Host to be decrypted and stored
27-
28-
![alt text][client]
2915

30-
31-
32-
## Host
16+
#### Running to Software
3317
The Host must run 'HostGUI.py'
3418

3519
This can be done by running the following while in the project root:
@@ -47,6 +31,33 @@ Only after a socket is made, may a host generate a key pair for encryption
4731

4832
The Host may now click 'Establish connection; send and recieve data' to wait for a Client to connect
4933

34+
## Client
35+
#### Saving your data
36+
To begin using this software to encrypt a message, the Client must save their desired data as a text file in:
37+
```
38+
./client/Message/Message_to_encrypt.txt
39+
```
40+
#### IP Address and Port Number
41+
Upon usage, the Client will be prompted to enter the Host's IP Address, as well as a port number
42+
43+
Both the IP Address and Port Number entered must match the Host's information
44+
45+
The Host will have their IP Address printed to the screen for self reference
46+
47+
For example:
48+
```
49+
Enter Host IP Address: 192.168.0.19
50+
Enter port number: 1234 (matches the Host's port number)
51+
```
52+
#### Running to Software
53+
The Client must run 'ClientGUI.py'
54+
This can be done by running the following while in the project root:
55+
``` bash
56+
$ ./scripts/run_client.sh
57+
```
58+
The Client may then choose to encrypt and send their message to the Host to be decrypted and stored
59+
60+
![alt text][client]
5061

5162
### Running on an IDE or Shell
5263
Useful information relating to the encryption/ decryption processes and connection statuses will be printed to the screen for both the Host and Client

0 commit comments

Comments
 (0)