diff --git a/README.md b/README.md index f21475f9..606af950 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ These tools have been introduced by Adobe to document Adobe's Experience Data Mo ## Example Output -Using the schemas in [`examples/schemas`](examples/schemas), the output in [`examples/docs`](examples/docs) has been generated. +Using the schemas in [`examples/schemas`](examples/schemas) (note the `*.schema.json` extension), the output in [`examples/docs`](examples/docs) has been generated. ## Installing and running @@ -32,6 +32,8 @@ $ jsonschema2md -d examples/schemas -o examples/docs # generated output for whole folder is written to ./examples/docs ``` +By default, `jsonschema2md` looks for schema files ending in `*.schema.json`. You can specify another extension by using the `--schema-extension` or `-e` command line argument. + ## Internationalization The generated documentation can be internationalized. Select the language you want to use for the output using the `-l` parameter.