From b4d6ed494dc998b51d743d2dfb744269a7da97d8 Mon Sep 17 00:00:00 2001
From: Kostiantyn Shyrolapov <kostya.shirolapov@gmail.com>
Date: Sat, 23 Mar 2024 22:24:29 -0400
Subject: [PATCH] Update README.md

---
 README.md | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

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