From 914e62b4496afc7a53142db24f8f6c80272b23ec Mon Sep 17 00:00:00 2001 From: Favour Kelvin <39309699+fakela@users.noreply.github.com> Date: Thu, 13 Aug 2020 20:00:06 +0100 Subject: [PATCH] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5d3e1bc2..66f0a286 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ ## Features - Extremely easy deployment -- [redoc-cli](https://github.com/Redocly/redoc/blob/master/cli/README.md) with ability to bundle your docs into **zero-dependency** HTML file +- [Redoc-cli](https://github.com/Redocly/redoc/blob/master/cli/README.md) with ability to bundle your docs into **zero-dependency** HTML file - Server Side Rendering ready - The widest OpenAPI v2.0 features support (yes, it supports even `discriminator`)
![](docs/images/discriminator-demo.gif) @@ -203,7 +203,7 @@ Also you may rewrite some predefined environment variables defined in [Dockerfil [ReDoc CLI](https://github.com/Redocly/redoc/blob/master/cli/README.md) tool is used to lint and bundle your OpenAPI definition(s) into **zero-dependency** HTML file. It can be installed as a development dependency in your project. ## Create-openapi-repo -[Create-openapi-repo](https://github.com/Redocly/create-openapi-repo) tool is used for splitting a single OpenAPI definition file into multiple files (compatible with version 3x only). You can also use this tool to start a new API definition. +[Create-openapi-repo](https://github.com/Redocly/create-openapi-repo) tool is used for splitting a single OpenAPI definition file into multiple files **compatible with version 3x only**. You can also use this tool to start a new API definition. ## Community Edition(CE) vs Premium Edition(PE) @@ -289,13 +289,13 @@ Redoc.init('http://petstore.swagger.io/v2/swagger.json', { ----------- -## Redocly products +## Redocly Products Redocly has a variety of products, this table shows an overview of all Redocly products. -| Tools | Description | Edition | -| :------------- | ---------- | ----------- | -| Redoc | The API reference documentation output from the OpenAPI definition. This free version has limited functionality. | Community Edition | +| Tools | Description | Edition | +| :------------- | :---------- | :----------- | +| Redoc | The API reference documentation output from the OpenAPI definition. This free version has limited functionality. | Community Edition | | create-openapi-repo | CLI tool for splitting a single OpenAPI definition file into multiple files (compatible with version 3x only). You can also use this CLI tool to start a new API definition. | Community Edition | | openapi-cli | CLI tool that provides linting against a customizable ruleset, as well as bundling of the OpenAPI files into a single file. You can also preview the output of your docs with the Redocly API References through this tool. | Community Edition | | Redocly API Reference | The premium version of Redoc – the API reference documentation output from the OpenAPI definition file. This premium version includes Try-it functionality, enhanced search, fast loading, special tags, and other features. | Premium Editon |