diff --git a/README.md b/README.md index e296c45..7ac1ef3 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ file manually. * [Creating a new configuration file](#creating-a-new-configuration-file) * [Setting default values](#setting-default-values) * [Command-line usage](#command-line-usage) + * [Exporting a configuration file](#exporting-a-configuration-file) + * [Importing a configuration file](#importing-a-configuration-file) * [Editing a configuration file](#editing-a-configuration-file) * [Using an external editor](#using-an-external-editor) * [Inline command line editor](#inline-command-line-editor) @@ -129,6 +131,26 @@ The command line interface can be executed by running `configlib` from the comma For the rest of this documentation, we will assume that you have the `configlib` command in your global path. +### Exporting a configuration file + +To export a configuration file, run the following command: + +```bash +configlib --config --export +``` + +Exported configuration files are stored as YAML files. + + > Note: if the filename is not specified, the configuration file will be exported to the current working directory with the name `.yaml` + +### Importing a configuration file + +To import a configuration file, you must specify a valid yaml file, run the following command: + +```bash +configlib --config --import +``` + ### Editing a configuration file There are two ways to edit a configuration file using ConfigLib