diff --git a/README.md b/README.md index 69960ad..b0fa157 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ -Install: +Generates JSDoc `@typedef` for every schema in OpenAPI spec. + +--- +### Install: `cargo install openapi-to-jsdoc` +### Usage `openapi-to-jsdoc -i https://api.example.com/openapi.json -o output.js` -Generates JSDoc `@typedef` for each schema found in `components.schemas` - `-i, --input` (default: `openapi.json`) - Takes in path to file or URL to `openapi.json` - `-i --output` (default: `types.js`) - Output file