diff --git a/README.md b/README.md index 92c6c6e7..8401c185 100644 --- a/README.md +++ b/README.md @@ -167,14 +167,7 @@ Here are detailed [options docs](#redoc-options-object). ## ReDoc CLI -You can use redoc cli by installing `redoc-cli` globally or using [npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b). - -Twe following commans are available: - -- `redoc-cli serve [spec]` - starts the server with `spec` rendered with ReDoc. Supports SSR mode (`--ssr`) and can watch the spec (`--watch`) -- `redoc-cli bundle [spec]` - bundles spec and ReDoc into **zero-dependency** HTML file. - -For more details run `redoc-cli --help`. +[See here](https://github.com/Rebilly/ReDoc/blob/react-rewrite/cli/README.md) ## Configuration diff --git a/cli/README.md b/cli/README.md index 31bf8398..de04413a 100644 --- a/cli/README.md +++ b/cli/README.md @@ -2,10 +2,26 @@ **[ReDoc](https://github.com/Rebilly/ReDoc)'s Command Line Interface** -[Documentation](https://github.com/Rebilly/ReDoc/tree/react-rewrite#redoc-cli) - ## Installation -TBD +You can use redoc cli by installing `redoc-cli` globally or using [npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b). ## Usage -TBD \ No newline at end of file + +Twe following commans are available: + +- `redoc-cli serve [spec]` - starts the server with `spec` rendered with ReDoc. Supports SSR mode (`--ssr`) and can watch the spec (`--watch`) +- `redoc-cli bundle [spec]` - bundles spec and ReDoc into **zero-dependency** HTML file. + +Some examples: + +- Bundle with main color changed to `orange`: + + `$ redoc-cli bundle [spec] --options.theme.colors.main=orange` +- Serve with `nativeScrollbars` option set to true: + + `$ redoc-cli serve [spec] --options.nativeScrollbars` +- Bundle using custom template (check [default template](https://github.com/Rebilly/ReDoc/blob/react-rewrite/cli/template.hbs) for reference): + + `$ redoc-cli bundle [spec] -t custom.hbs` + +For more details run `redoc-cli --help`. \ No newline at end of file