Skip to content

Commit

Permalink
Refactor table formatting in README.md (#93)
Browse files Browse the repository at this point in the history
  • Loading branch information
inromualdo authored Mar 13, 2024
1 parent 4e4103a commit b08a77c
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,14 @@ required | boolean | True if the object should not exist without this informatio
#### ConfigPropertyType
The `ConfigPropertyType` defines a property's validation rules and auto-formatting rules. The optional `parameter` information alters the behavior of the `ConfigPropertyType`.

Type | Validation Rules | Auto Formatting Rules | Validator | parameter
-- | -- | -- | --
string | Must be defined | Removes double whitespaces, leading or trailing whitespaces, and any character which is not alphanumeric or ` ()\-'` | None
name | Must be defined | Same as string + title case + `parameter` behavior | One or more regexes which are removed from the value when matched (eg. `"parameter": ["\\sCHU"]` will format `This Unit` into `This`)
regex | Must match the `regex` captured by `parameter` | Same as `string` | A regex which must be matched to pass validation (eg. `"parameter": "^\\d{6}$"` will accept only 6 digit numbers)
phone | A valid phone number for the specified locality | Auto formatting provided by [libphonenumber](https://github.com/google/libphonenumber) | Two letter country code specifying the locality of phone number (eg. `"parameter": "KE"`)
none | None | None | None
gender | A binary gender (eg. `Male`, `Woman`, `M`) | Formats to either `Male` or `Female` | None
| Type | Validation Rules | Auto Formatting Rules | Validator | parameter |
|--------|--------------------------------------------------------|---------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|---------------|
| string | Must be defined | Removes double whitespaces, leading or trailing whitespaces, and any character which is not alphanumeric or ` ()\-'` | None |
| name | Must be defined | Same as string + title case + `parameter` behavior | One or more regexes which are removed from the value when matched (eg. `"parameter": ["\\sCHU"]` will format `This Unit` into `This`) |
| regex | Must match the `regex` captured by `parameter` | Same as `string` | A regex which must be matched to pass validation (eg. `"parameter": "^\\d{6}$"` will accept only 6 digit numbers) |
| phone | A valid phone number for the specified locality | Auto formatting provided by [libphonenumber](https://github.com/google/libphonenumber) | Two letter country code specifying the locality of phone number (eg. `"parameter": "KE"`) |
| none | None | None | None |
| gender | A binary gender (eg. `Male`, `Woman`, `M`) | Formats to either `Male` or `Female` | None |

### Deployment
This tool is available via Docker by running `docker compose up`. Set the [Environment Variables](#environment-variables).
Expand Down

0 comments on commit b08a77c

Please sign in to comment.