- **OpenAPI/Swagger-generated API Reference Documentation**
+
- **OpenAPI/Swagger-generated API Reference Documentation**
+ 
](https://github.com/Rebilly/generator-openapi-repo#generator-openapi-repo--) [
](https://redoc.ly) [
](https://redoc.ly/#services)
+
+ **What's the difference between ReDoc and Redoc.ly?**
+
+ Describe the difference, mention other products, insert link to detailed feature comparison.
+
+ ## Project Status
+
[](https://travis-ci.org/Redocly/redoc) [](https://coveralls.io/github/Redocly/redoc?branch=master) [](https://david-dm.org/Redocly/redoc) [](https://david-dm.org/Redocly/redoc#info=devDependencies) [](https://www.npmjs.com/package/redoc) [](https://github.com/Redocly/redoc/blob/master/LICENSE)
[](https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js) [](https://www.npmjs.com/package/redoc) [](https://www.jsdelivr.com/package/npm/redoc) [](https://hub.docker.com/r/redocly/redoc/)
-
-
-**This is README for `2.0` version of ReDoc (React based). README for `1.x` version is on the branch [v1.x](https://github.com/Redocly/redoc/tree/v1.x)**
+# Table of Contents
-
+# Feature Guide
-## [Live demo](http://redocly.github.io/redoc/)
-
-[](https://github.com/Rebilly/generator-openapi-repo#generator-openapi-repo--) [](https://redoc.ly) [](https://redoc.ly/#services)
+Insert a table that compares ReDoc Community Edition features and premium features.
## Features
- Extremely easy deployment
@@ -36,43 +56,26 @@
- Simple integration with `create-react-app` ([sample](https://github.com/APIs-guru/create-react-app-redoc))
- Branding/customizations via [`theme` option](#redoc-options-object)
-## Roadmap
- - [x] ~~[OpenAPI v3.0 support](https://github.com/Redocly/redoc/issues/312)~~
- - [x] ~~performance optimizations~~
- - [x] ~~better navigation (menu improvements + search)~~
- - [x] ~~React rewrite~~
- - [x] ~~docs pre-rendering (performance and SEO)~~
- - [ ] ability to simple branding/styling
- - [ ] built-in API Console
-## Releases
-**Important:** all the 2.x releases are deployed to npm and can be used via jsdeliver:
-- particular release, e.g. `v2.0.0-alpha.15`: https://cdn.jsdelivr.net/npm/redoc@2.0.0-alpha.17/bundles/redoc.standalone.js
-- `next` release: https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js
+# Quick Start Guide
-Additionally, all the 1.x releases are hosted on our GitHub Pages-based CDN **(deprecated)**:
-- particular release, e.g. `v1.2.0`: https://rebilly.github.io/ReDoc/releases/v1.2.0/redoc.min.js
-- `v1.x.x` release: https://rebilly.github.io/ReDoc/releases/v1.x.x/redoc.min.js
-- `latest` release: https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js - it will point to latest 1.x.x release since 2.x releases are not hosted on this CDN but on unpkg.
+- Provide steps for the fastest way to build something
+- Clarify that OpenAPI specs must be edited in another tool - redoc only builds them!
-## Version Guidance
-| ReDoc Release | OpenAPI Specification |
-|:--------------|:----------------------|
-| 2.0.0-alpha.x | 3.0, 2.0 |
-| 1.19.x | 2.0 |
-| 1.18.x | 2.0 |
-| 1.17.x | 2.0 |
-## Some Real-life usages
-- [Rebilly](https://rebilly-api.redoc.ly/)
-- [Docker Engine](https://docs.docker.com/engine/api/v1.25/)
-- [Zuora](https://www.zuora.com/developer/api-reference/)
-- [Discourse](http://docs.discourse.org)
-- [Commbox](https://www.commbox.io/api/)
-- [APIs.guru](https://apis.guru/api-doc/)
-- [FastAPI](https://github.com/tiangolo/fastapi)
+## Support
-## Deployment
+Links to
+
+- **FAQ**
+- **Documentation**
+- **How to report an issue**
+
+
+# Installation and Usage
+
+- List all supported ways to install and deploy
+- For each, include **Dependencies and Prerequisites**
### TL;DR
@@ -202,6 +205,8 @@ Also you may rewrite some predefined environment variables defined in [Dockerfil
[See here](https://github.com/Redocly/redoc/blob/master/cli/README.md)
+
+
## Configuration
### Security Definition location
@@ -270,6 +275,61 @@ Redoc.init('http://petstore.swagger.io/v2/swagger.json', {
}, document.getElementById('redoc-container'))
```
------------
-## Development
+
+# Who is using ReDoc?
+
+- [Rebilly](https://rebilly-api.redoc.ly/)
+- [Docker Engine](https://docs.docker.com/engine/api/v1.25/)
+- [Zuora](https://www.zuora.com/developer/api-reference/)
+- [Discourse](http://docs.discourse.org)
+- [Commbox](https://www.commbox.io/api/)
+- [APIs.guru](https://apis.guru/api-doc/)
+- [FastAPI](https://github.com/tiangolo/fastapi)
+
+
+# Project Development
+
+
+## Roadmap
+
+ - [x] ~~[OpenAPI v3.0 support](https://github.com/Redocly/redoc/issues/312)~~
+ - [x] ~~performance optimizations~~
+ - [x] ~~better navigation (menu improvements + search)~~
+ - [x] ~~React rewrite~~
+ - [x] ~~docs pre-rendering (performance and SEO)~~
+ - [ ] ability to simple branding/styling
+ - [ ] built-in API Console
+
+
+## Contributing
+
see [CONTRIBUTING.md](.github/CONTRIBUTING.md)
+
+mention career options
+
+
+## Releases
+
+**Important:** all the 2.x releases are deployed to npm and can be used via jsdeliver:
+- particular release, e.g. `v2.0.0-alpha.15`: https://cdn.jsdelivr.net/npm/redoc@2.0.0-alpha.17/bundles/redoc.standalone.js
+- `next` release: https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js
+
+Additionally, all the 1.x releases are hosted on our GitHub Pages-based CDN **(deprecated)**:
+- particular release, e.g. `v1.2.0`: https://rebilly.github.io/ReDoc/releases/v1.2.0/redoc.min.js
+- `v1.x.x` release: https://rebilly.github.io/ReDoc/releases/v1.x.x/redoc.min.js
+- `latest` release: https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js - it will point to latest 1.x.x release since 2.x releases are not hosted on this CDN but on unpkg.
+
+## OpenAPI Version Support
+
+| ReDoc Release | OpenAPI Specification |
+|:--------------|:----------------------|
+| 2.0.0-alpha.x | 3.0, 2.0 |
+| 1.19.x | 2.0 |
+| 1.18.x | 2.0 |
+| 1.17.x | 2.0 |
+
+
+
+## License
+
+Add license information.