Skip to content

Commit 0f0d050

Browse files
authored
Merge pull request #3 from dev-xero/docs/readme-update
feat(docs): Updated readme file
2 parents 0a946e7 + 9a1ed29 commit 0f0d050

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ Three arguments must be supplied to the program in order for it to work,
1515

1616
The last argument, `-e` is optional, when set, the program will write the result of a successful encryption to a plain text file named: `decryption_key_[encrypted text]-[shift distance].txt` stored in a directory called "encrypted". Which contains the encrypted text and the negative shift distance to decrypt the text.
1717

18+
> [!NOTE]
19+
> The flag is ignored when `-de` is used.
20+
1821
## Example
1922
Assume we have some password we want to encrypt, as a result of our clever thinking, we come up with `password` (don't ever use "password" as a password, at least without encrypting it), applying the shift cipher algorithm to it using a shift distance of `8`, we get:
2023
- Original: `p` `a` `s` `s` `w` `o` `r` `d`

0 commit comments

Comments
 (0)