Skip to content

Commit d053fae

Browse files
committed
updated README
1 parent 8f88887 commit d053fae

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,32 @@
11
# cipher-cli
2+
Encrypt and decrypt messages using various algorithms
3+
4+
## How to use it
5+
```sh
6+
cipher-cli v0.0.0.1, (C) Vincibean
7+
8+
algo [COMMAND] ... [OPTIONS]
9+
Encrypt and decrypt messages using various algorithms
10+
11+
Common flags:
12+
-e --encrypt Encrypt a message
13+
-d --decrypt Decrypt a message
14+
-m --msg=ITEM The message to encrypt / decrypt
15+
-? --help Display help message
16+
-V --version Print version information
17+
--numeric-version Print just the version number
18+
-v --verbose Loud verbosity
19+
-q --quiet Quiet verbosity
20+
21+
algo caesar [OPTIONS]
22+
Use Caesar's encryption / decryption algorithm
23+
24+
-n --numkey=INT The integer to use as key. It can be either a
25+
positive or a negative number
26+
27+
algo vigenere [OPTIONS]
28+
Use Vigenere's encryption / decryption algorithm
29+
30+
-s --stringkey=ITEM The string to use as key. It must not be an empty
31+
string
32+
```

0 commit comments

Comments
 (0)