Improve Usage section in README.md

phpinnacle / intellij-redoc

IntelliJ OpenAPI 3.0 documentation renderer

MIT License

8 stars 1 forks source link

Improve Usage section in README.md #6

Open TheWall89 opened 4 years ago

TheWall89 commented 4 years ago

Detailed description

Improve the Usage section in the README with a better description on how to use this plugin. Maybe I'm dumb, but I spent several minutes looking for the small Redoc tab at the bottom left of my OpenAPI file. A short description of the added tab and/or a screenshot would be appreciated.

Context

Ease the plugin adoption from new users.

Your environment

Version used: Jetbrains JRE, IntelliJ IDEA 2019.3
Operating system and version: Archlinux

andrei572 commented 4 years ago

I still can't figure out how to run the plugin on a Mac.

TheWall89 commented 4 years ago

I still can't figure out how to run the plugin on a Mac.

Open your YAML/Json OpenAPI specification. Check the bottom left of the editor tab and click on the Redoc button. Screenshot attached. redoc