diff --git a/README.md b/README.md index 6467731..162a795 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,47 @@ # HTTP forms defined in YAML -... +This module allows creating simple interfaces to forms/payloads for use in HTTP POST requests by defining them in highly readable and easily maintainable YAML files. + +## Form definition + +A form is defined by its fields. + +A field is defined by an **alias** (for internal use) and the field's **name**, which is the parameter name in the payload sent during a `POST` request, and which typically corresponds to the `name` attribute of a `` HTML tag. + +Optionally, a field can have a **default** value, value **options** (as `