Skip to content

Commit

Permalink
Updates per reviews and adds new logo
Browse files Browse the repository at this point in the history
  • Loading branch information
HCloward committed Sep 23, 2021
1 parent 899d7f9 commit 669addd
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center">
<img alt="ReDoc logo" src="https://raw.githubusercontent.com/Redocly/redoc/master/docs/images/redoc-logo.png" width="400px" />
<img alt="ReDoc logo" src="/docs/images/redoc.png" width="400px" />

# Generate interactive API documentation from OpenAPI definitions

Expand All @@ -13,10 +13,13 @@

## About Redoc

Redoc is an open-source tool for generating OpenAPI(aka Swagger) definitions. By default
Redoc offers a three-panel, responsive layout: the left panel contains a search bar and navigation menu,
the central panel contains the documentation, and the right panel contains request and response
examples.
Redoc is an open-source tool for generating documentation from OpenAPI (fka Swagger) definitions.

By default Redoc offers a three-panel, responsive layout:

- The left panel contains a search bar and navigation menu.
- The central panel contains the documentation.
- The right panel contains request and response examples.

![ReDoc demo](https://raw.githubusercontent.com/Redocly/redoc/master/demo/redoc-demo.png)

Expand Down
Binary file added docs/images/redoc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 669addd

Please sign in to comment.