Skip to content

Commit

Permalink
docs(readme): add note on default extensions
Browse files Browse the repository at this point in the history
see #250  fixes #110
  • Loading branch information
trieloff authored Apr 12, 2021
1 parent 49acb70 commit 72e27cf
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down

0 comments on commit 72e27cf

Please sign in to comment.