Skip to content

Commit 20e5591

Browse files
authored
Update README.md
1 parent 91b80bc commit 20e5591

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ Simple lightweight java program that encrypt and decrypt text file using XOR enc
44
## Table of Contents
55

66
1. [Download & Instalation](#download--instalation)
7-
2. [XOR explenation](#what-is-xor)
8-
3. [Contributing](#contributing)
9-
4. [To Do](#to-do)
10-
5. [License](#license)
7+
2. [Usage](#how-to-use-this-app)
8+
3. [XOR explenation](#what-is-xor)
9+
4. [Contributing](#contributing)
10+
5. [To Do](#to-do)
11+
6. [License](#license)
1112

1213

1314
## Download & Instalation
@@ -19,6 +20,15 @@ java -jar XOREncrypt-1.0.jar
1920
```
2021
4. Enjoy the encryption program. 😎
2122

23+
## How to use this app
24+
There is 4 files: input.txt, encryption.data, output.txt and key.properties. Files are generated automaticly.
25+
First of all you need to paste some text or data in `input.txt`, after that program will ask you for key word for example `crocodile.` Key word can be saved in `key.properties` file and store in somekind of storage.
26+
Next program will ask to select encrypting or decrypting. Make sure that files aren't empty. Once selected, the program will start encryption and decryption based on your selection.
27+
28+
If you selected encryption output will be in `encryption.data` file but if you seleced decryption output will be in `output.txt` file.
29+
30+
For all functions you need key word that can be stored in `key.properties` file or manually on piece of paper.
31+
2232
## What is XOR
2333
XOR is one of the best encryption that use special key word. The XOR encryption algorithm is an example of symmetric encryption where the same key is used to both encrypt and decrypt a message.
2434

@@ -31,4 +41,4 @@ Pull requests are always welcome. For bigger changes, please open an issue first
3141
- [ ] Add gui using JFrame where you can manage everything
3242

3343
## License
34-
[GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/)
44+
[GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/)

0 commit comments

Comments
 (0)