Skip to content

Commit 2c643c4

Browse files
committed
updated README.md
1 parent b9ec527 commit 2c643c4

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

README.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,46 +4,55 @@
44

55
## Installation
66

7-
````
7+
```
88
git clone https://github.com/nodesocket/cryptr.git
99
ln -s "$PWD"/cryptr/cryptr.bash /usr/local/bin/cryptr
10-
````
10+
```
1111

1212
## API/Commands
1313

1414
### encrypt
1515

16-
> encrypt \<file\> - Encryptes file with OpenSSL AES-128 cipher block chaining. Writes an encrypted file out *(ciphertext)* appending `.aes` extention.
16+
> encrypt \<file\> - Encryptes file with OpenSSL AES-128 cipher block chaining. Writes an encrypted file out *(ciphertext)* appending `.aes` extension.
1717
18-
````
18+
```
1919
➜ cryptr encrypt ./secrets-file
2020
enter aes-128-cbc encryption password:
2121
Verifying - enter aes-128-cbc encryption password:
22+
```
23+
24+
```
2225
➜ ll
2326
-rw-r--r-- 1 user group 1.0G Oct 1 13:33 secrets-file
2427
-rw-r--r-- 1 user group 1.0G Oct 1 13:34 secrets-file.aes
25-
````
28+
```
2629

2730

2831
### decrypt
2932

30-
> decrypt \<file.aes\> - Decrypt encrypted file using OpenSSL AES-128 cipher block chaining. Writes a decrypted file out *(plaintext)* removing `.aes` extention.
33+
> decrypt \<file.aes\> - Decrypt encrypted file using OpenSSL AES-128 cipher block chaining. Writes a decrypted file out *(plaintext)* removing `.aes` extension.
3134
32-
````
35+
```
3336
➜ ll
3437
-rw-r--r-- 1 user group 1.0G Oct 1 13:34 secrets-file.aes
38+
```
39+
40+
```
3541
➜ cryptr decrypt secrets-file.aes
3642
enter aes-128-cbc decryption password:
43+
```
44+
45+
```
3746
➜ ll
3847
-rw-r--r-- 1 user group 1.0G Oct 1 13:35 secrets-file
3948
-rw-r--r-- 1 user group 1.0G Oct 1 13:34 secrets-file.aes
40-
````
49+
```
4150

4251
### help
4352

4453
> help - Displays help
4554
46-
````
55+
```
4756
➜ cryptr help
4857
Usage: cryptr command <command-specific-options>
4958
@@ -52,16 +61,16 @@ Usage: cryptr command <command-specific-options>
5261
help Displays help
5362
version Displays the current version
5463
55-
````
64+
```
5665

5766
### version
5867

5968
> version - Displays the current version
6069
61-
````
70+
```
6271
➜ cryptr version
6372
cryptr 1.0.0
64-
````
73+
```
6574

6675
### default
6776

0 commit comments

Comments
 (0)