Improve usage documentation - Githubissues

phpinnacle / intellij-redoc

IntelliJ OpenAPI 3.0 documentation renderer

MIT License

8 stars 1 forks source link

Improve usage documentation #8

Open TheWall89 opened 4 years ago

TheWall89 commented 4 years ago

Description

Improve the Usage section in the README.md file.

Motivation and context

fixes #6

How has this been tested?

It's documentation. No tests needed.

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[x] I have read the CONTRIBUTING document.
[ ] My pull request addresses exactly one patch/feature.
[ ] I have created a branch for this patch/feature.
[ ] Each individual commit in the pull request is meaningful.
[ ] I have added tests to cover my changes.
[x] If my change requires a change to the documentation, I have updated it accordingly.