From 08476e5346833263d47f01e13d0a749c338361c2 Mon Sep 17 00:00:00 2001 From: William Petit Date: Mon, 9 May 2022 14:37:43 +0200 Subject: [PATCH] chore: update README --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ed79421..a1166ea 100644 --- a/README.md +++ b/README.md @@ -26,14 +26,21 @@ It will download `frmd` to your current directory. |----|-----------|-------| |`FORMIDABLE_VERSION`|Formidable version to download|`latest`| |`FORMIDABLE_DESTDIR`|Formidable destination directory|`.`| +### URLs -## Usage +Formidable uses URLs to define how to handle schemas/defaults/values. -### Defining a schema +For example, to edit a web available schema (in YAML), defaults from `stdin` (in JSON) and values from the local file system (in HCL): -### Using default values +```shell +echo '{}' | frmd \ + edit + --schema https://example.com/my-schema.yml \ + --defaults stdin://local?format=json \ + --values file:///my/file/absolute/path.hcl +``` -### Handling values update +The `?format=` query variable allows to specify the file format when no file extension is available (for example when reading from `stdin`). ## Licence