diff --git a/README.md b/README.md index d6e462f..088bd28 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,11 @@ openapi-generator-cli generate -g -i https://raw.githubusercontent.co There are several outputs, but the one that best follows the OpenAPI specification is `dist/docs`. However, some Generators may use a syntax that is not supported. + +There are several outputs, but the one that most closely follows the OpenAPI specification is `dist/docs`. +However, a lot of syntax that is not supported by some generators is used. +Therefore, it is recommended to use `dist/compatible` or `dist/compatible_discriminator`. + You can also modify the hook to make the generated results more user-friendly. [build_config.py](./tools/build_config.py) Note that the license also inherits to the output.