Cadoles/formidable
10
0
Fork 0
mirror of https://github.com/Bornholm/formidable.git synced 2024-12-26 00:39:33 +01:00
Code Issues Projects Releases Wiki Activity

chore: update README

Browse Source
This commit is contained in:
wpetit 2022-05-09 14:37:43 +02:00
parent 9e851f2e69
commit 08476e5346
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -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=<json|yaml|hcl>` query variable allows to specify the file format when no file extension is available (for example when reading from `stdin`).
## Licence