Update README.md
This commit is contained in:
parent
00569e78dc
commit
e59f5fd2be
1 changed files with 19 additions and 19 deletions
38
README.md
38
README.md
|
@ -29,6 +29,25 @@ To build from source, you'll also require:
|
|||
|
||||
You can also fetch a pre-compiled binary version of MFM.
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
### Command Line Options
|
||||
|
||||
```
|
||||
Usage: mfm [options]
|
||||
|
||||
Global options:
|
||||
-c, --config FILE Define configuration file
|
||||
-h, --help Showcase this help
|
||||
|
||||
Commands:
|
||||
create Instantiate a new vault
|
||||
delete Erase an existing vault
|
||||
edit Adjust the configuration
|
||||
```
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
The script harnesses a YAML configuration file, typically located at `~/.config/mfm.yml`, which outlines vault names and paths.
|
||||
|
@ -56,25 +75,6 @@ fsmap:
|
|||
# Incorporate more vaults as necessary
|
||||
```
|
||||
|
||||
## Command Line Options
|
||||
|
||||
```
|
||||
Usage: mfm [options]
|
||||
|
||||
Global options:
|
||||
-c, --config FILE Define configuration file
|
||||
-h, --help Showcase this help
|
||||
|
||||
Commands:
|
||||
create Instantiate a new vault
|
||||
delete Erase an existing vault
|
||||
edit Adjust the configuration
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
After setting up the YAML, activate the script. Employ `fzf` to pick a vault to mount or unmount.
|
||||
|
||||
## Contribution Guidelines
|
||||
|
||||
To contribute to MFM:
|
||||
|
|
Loading…
Add table
Reference in a new issue