Skip to content
This repository was archived by the owner on Oct 4, 2021. It is now read-only.

Commit 35d1d44

Browse files
committed
Updated README.md
1 parent 8302207 commit 35d1d44

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

+12-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# filecrypt
2-
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/12610588667845698ee710628e313c0b)](https://www.codacy.com/gh/flew-software/filecrypt/dashboard?utm_source=github.com&utm_medium=referral&utm_content=flew-software/filecrypt&utm_campaign=Badge_Grade)
2+
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/12610588667845698ee710628e313c0b)](https://www.codacy.com/gh/flew-software/filecrypt/dashboard?utm_source=github.com&utm_medium=referral&utm_content=flew-software/filecrypt&utm_campaign=Badge_Grade)
3+
[![](https://tokei.rs/b1/github/flew-software/filecrypt?category=lines)](https://github.com/flew-software/filecrypt)
34
![GitHub repo size](https://img.shields.io/github/repo-size/flew-software/filecrypt)
45
[![Written in](https://img.shields.io/badge/Written%20in-golang-blue)](https://golang.org)
56
A super easy to use file encryption utility written in golang
@@ -18,8 +19,18 @@ A super easy to use file encryption utility written in golang
1819
4. Add the path of the created folder created in step 2 into [windows path variable](https://docs.alfresco.com/4.2/tasks/fot-addpath.html)
1920
5. Open the command prompt and enter `filecrypt --help` for detailed info about using flags
2021

22+
#### flags
23+
* `--force` - Force write even if a file exists with that name (overwrite) DESTRUCTIVE
24+
* `--location` - The location of the file to encrypt/decrypt(determined by the mode flag)
25+
* `--mode` - FileCrypt mode (encrypt/decrypt These can be replaced with their first letters) Example: `filecrypt --mode=e --location="super secret file.txt" --password="test"`
26+
* `--password` - Password to be used while encrypting/decrypting
27+
2128
## How can I help?
2229
* Staring this project on github
2330
* Creating issues
2431
* Contributing with code or documentation
2532
* Sharing this project with your friends
33+
34+
## What is a .fcef file
35+
fcef (File. Crypt. Encrypted. File) is an encrypted file that is generated by FileCrypt,
36+
If you know the password that it was encrypted with it can be decrypted with FileCrypt using the `--mode=d`or `--mode=decrypt` flag.

0 commit comments

Comments
 (0)