From 37c2ea098cd347922b8da7990aadff07d8a714fd Mon Sep 17 00:00:00 2001 From: Lars Trieloff <trieloff@adobe.com> Date: Tue, 9 Oct 2018 11:26:42 +0000 Subject: [PATCH] Mention support for draft 04, 06, and 07, fixes #79 --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 9307085..188e439 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,19 @@ $ node cli.js $ node cli.js -d examples/schemas -o examples/docs # generated output for whole folder is written to ./examples/docs ``` +## JSON Schema Draft Versions + +`jsonschema2md` assumes `draft-07` by default. If your schemas are not on `draft-07`, you can specify the draft version using the `-v` or `--draft` flag. + +```bash +# run against JSON Schema Draft 04 +$ node cli.js -d examples/schemas -o examples/docs -v 04 +``` + +```bash +# run against JSON Schema Draft 06 +$ node cli.js -d examples/schemas -o examples/docs -v 06 +``` ### Installing the `jsonschema2md` Command Line Tools -- GitLab