Skip to content

Commit 2d7a66f

Browse files
committed
v0.2.0
1 parent 235c238 commit 2d7a66f

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
1717
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
18+
1819
**Table of Contents**
1920

2021
- [Description](#description)
@@ -167,13 +168,14 @@ flowchart TD;
167168

168169
**encrypt**
169170

170-
Encrypt `/path/to/sourcefile.xlsx` to `/path/to/sourcefile.xlsx.aes` with environment password-variable `my_secret_var`
171+
Encrypt `/path/to/sourcefile.xlsx` to `/path/to/sourcefile.xlsx.aes` with environment password-variable
171172

172173
```cli
173-
./file_encryption-decryption-x86_64.AppImage --source /path/to/sourcefile.xlsx --pwd my_secret_var
174+
export my_secret_env_var="my_top_secret_password"
175+
./file_encryption-decryption-x86_64.AppImage --source /path/to/sourcefile.xlsx --pwd my_secret_env_var
174176
```
175177

176-
Encrypt `/path/to/sourcefile.xlsx` to `/new/path/to/targetfile.xlsx.aes` with dotenv-file (`PWD=$my_secret_var`)
178+
Encrypt `/path/to/sourcefile.xlsx` to `/new/path/to/targetfile.xlsx.aes` with dotenv-file
177179

178180
```cli
179181
./file_encryption-decryption-x86_64.AppImage --source /path/to/sourcefile.xlsx --target /new/path/to/targetfile.xlsx --dotenv /my/configpath/.file_enc-dec
@@ -188,29 +190,32 @@ Encrypt `/path/to/sourcefile.xlsx` to `/new/path/to/targetfile.xlsx.aes` with do
188190
Decrypt `/path/to/sourcefile.xlsx.aes` to `/path/to/sourcefile.xlsx`
189191

190192
```cli
191-
./file_encryption-decryption-x86_64.AppImage --source /path/to/sourcefile.xlsx.aes
193+
./file_encryption-decryption-x86_64.AppImage --source /path/to/sourcefile.xlsx.aes ...
192194
```
193195

194196
Decrypt `/path/to/sourcefile.xlsx.aes` to `/new/path/to/targetfile.xlsx`
195197

196198
```cli
197-
./file_encryption-decryption-x86_64.AppImage --source /path/to/sourcefile.xlsx.aes --target /new/path/to/targetfile.xlsx
199+
./file_encryption-decryption-x86_64.AppImage --source /path/to/sourcefile.xlsx.aes --target /new/path/to/targetfile.xlsx ...
198200
```
199201

200202
## configuration: dotenv or env
201203

202204
Example dotenv file `.env`
203205

206+
```cli
207+
export my_env_secret="my_top_secret_password"
208+
# => PWD => $my_secret_env_var => my_top_secret_password
209+
```
210+
204211
```dotenv
205212
SOURCE_FILE=/inpath/to/file.xlsx # Mandatory or mandatory via argument --source
206213
TARGET_FILE=/outpath/to/file.xlsx # Optional or optional via argument --target
207-
PWD=my_env_secret # Mandatory get password from $my_env_secret or mandatory via --pwd my_env_secret
214+
PWD=my_secret_env_var # Mandatory get password from $my_secret_env_var or mandatory via --pwd my_secret_env_var
208215
```
209216

210-
Example pwd environmwent variable
211-
212-
```cli
213-
export PWD="top_secret_password"
217+
````cli
218+
./file_encryption-decryption-x86_64.AppImage --source /path/to/sourcefile.xlsx --pwd my_secret_env_var
214219
```
215220
216221
## Test / Performance
@@ -300,6 +305,7 @@ An utility to load environment variables from a .env file
300305
## folder structure
301306
302307
<!-- readme-tree start -->
308+
303309
```
304310
.
305311
├── .github
@@ -348,6 +354,7 @@ An utility to load environment variables from a .env file
348354
349355
10 directories, 34 files
350356
```
357+
351358
<!-- readme-tree end -->
352359
353360
<p align="right">(<a href="#top">back to top</a>)</p>
@@ -393,3 +400,4 @@ SOFTWARE.
393400
:vulcan_salute:
394401
395402
<p align="right">(<a href="#top">back to top</a>)</p>
403+
````

0 commit comments

Comments
 (0)