From 94b23732223336281c11a4b225e3830692aa2214 Mon Sep 17 00:00:00 2001 From: JMARyA Date: Tue, 26 Mar 2024 13:20:03 +0100 Subject: [PATCH] update README --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 88b43b4..9950d89 100644 --- a/README.md +++ b/README.md @@ -4,5 +4,15 @@ Validate markdown frontmatter using [JSON Schemas](https://json-schema.org) ## Usage ```shell -$ mdlint [OPTION] -``` \ No newline at end of file +$ mdlint [OPTIONS] +``` + +### Options + +| Option | Description | +| ---------------------------------- | ------------------------------------------------------------------------------------- | +| `-g, --greedy` | Require all properties to be present even if they are not strictly required in schema | +| `-e, --empty-frontmatter` | Treat missing frontmatter as empty frontmatter | +| `-i, --ignore-missing-frontmatter` | Dont print an error when no frontmatter has been found | +| `-h, --help` | Print help | +| `-V, --version` | Print version | \ No newline at end of file