Update README.md
This commit is contained in:
parent
ed3555c689
commit
e061f6601d
1 changed files with 9 additions and 9 deletions
18
README.md
18
README.md
|
@ -2,9 +2,16 @@
|
|||
|
||||
GX-Vault Manager is a Crystal-lang script designed to simplify the management of encrypted vaults using `gocryptfs`. With its user-friendly interface, users can seamlessly mount and unmount vaults, get real-time vault status, and handle errors gracefully.
|
||||
|
||||
## Prerequisites
|
||||
## Prerequisites & dependencies
|
||||
|
||||
- **gocryptfs**: Ensure you have `gocryptfs` installed on your system before using GX-Vault Manager.
|
||||
Ensure you have the following tools installed on your system before running GX-Vault:
|
||||
|
||||
- **gocryptfs**: <https://github.com/rfjakob/gocryptfs>
|
||||
- **fzf**: <https://github.com/junegunn/fzf>
|
||||
|
||||
If you want to build from source, you'll also need:
|
||||
|
||||
- **crystal-lang** : <https://crystal-lang.org/>
|
||||
|
||||
## Installation
|
||||
|
||||
|
@ -53,13 +60,6 @@ Commands:
|
|||
|
||||
Post YAML configuration, run the script. Use `fzf` to select a vault to mount or unmount.
|
||||
|
||||
## Dependencies
|
||||
|
||||
- gocryptfs
|
||||
- fzf
|
||||
- Crystal-lang
|
||||
- Additional Crystal-lang script dependencies
|
||||
|
||||
## Contribution Guidelines
|
||||
|
||||
To contribute to GX-Vault Manager:
|
||||
|
|
Loading…
Add table
Reference in a new issue