From 913b3a422fb92f905ec7e726e434b81e20104309 Mon Sep 17 00:00:00 2001
From: Oprysk Vyacheslav <oprusk230992@gmail.com>
Date: Thu, 9 Dec 2021 15:27:31 +0200
Subject: [PATCH] chore: update docs (#1825)

---
 README.md | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 4af6ad0e..ddf2a595 100644
--- a/README.md
+++ b/README.md
@@ -8,14 +8,14 @@
   [![bundle size](http://img.badgesize.io/https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js?compression=gzip&max=300000)](https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js) [![npm](https://img.shields.io/npm/dm/redoc.svg)](https://www.npmjs.com/package/redoc) [![](https://data.jsdelivr.com/v1/package/npm/redoc/badge)](https://www.jsdelivr.com/package/npm/redoc) [![Docker Build Status](https://img.shields.io/docker/build/redocly/redoc.svg)](https://hub.docker.com/r/redocly/redoc/)
 </div>
 
-**This is the README for the `2.x` version of Redoc (React-based).** 
+**This is the README for the `2.x` version of Redoc (React-based).**
 **The README for the `1.x` version is on the [v1.x](https://github.com/Redocly/redoc/tree/v1.x) branch**
 
 ## About Redoc
 
-Redoc is an open-source tool for generating documentation from OpenAPI (fka Swagger) definitions. 
+Redoc is an open-source tool for generating documentation from OpenAPI (fka Swagger) definitions.
 
-By default Redoc offers a three-panel, responsive layout: 
+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.
@@ -133,7 +133,7 @@ Additionally, all the 1.x releases are hosted on our GitHub Pages-based CDN **(d
 
 Redocly's OpenAPI CLI is an open source command-line tool that you can use to lint
 your OpenAPI definition. Linting helps you to catch errors and inconsistencies in your
-OpenAPI definition before publishing. 
+OpenAPI definition before publishing.
 
 Refer to [Lint configuration](https://redoc.ly/docs/cli/guides/lint/) in the OpenAPI documentation for more information.
 
@@ -173,10 +173,10 @@ replace the `spec-url` attribute with the url or local file address to your defi
 ```
 
 For step-by-step instructions for how to get started using Redoc
-to render your OpenAPI definition, refer to the 
+to render your OpenAPI definition, refer to the
 [**Redoc quickstart guide**](https://redoc.ly/docs/redoc/quickstart/intro/).
 
-See [**IE11 Support Notes**](docs/usage-with-ie11.md) for information on 
+See [**IE11 Support Notes**](docs/usage-with-ie11.md) for information on
 IE support for Redoc.
 
 ## Redoc CLI
@@ -240,6 +240,9 @@ You can use all of the following options with the standalone version of the <red
 * `payloadSampleIdx` - if set, payload sample will be inserted at this index or last. Indexes start from 0.
 * `theme` - ReDoc theme. For details check [theme docs](#redoc-theme-object).
 * `untrustedSpec` - if set, the spec is considered untrusted and all HTML/markdown is sanitized to prevent XSS. **Disabled by default** for performance reasons. **Enable this option if you work with untrusted user data!**
+* `sideNavStyle` - can be specified in various ways:
+  * **summary-only**: displays a summary in the sidebar navigation item. (**default**)
+  * **path-only**: displays a path in the sidebar navigation item.
 
 ### `<redoc>` theme object
 * `spacing`