Update README.md

kshyr · Mar 24, 2024 · b4d6ed4 · b4d6ed4
1 parent ff75c00
commit b4d6ed4
Showing 1 changed file with 5 additions and 2 deletions.
diff --git 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