diff --git a/README.md b/README.md index 92b5d16..fb4d218 100644 --- a/README.md +++ b/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: