chore: update redoc-cli docs

This commit is contained in:
Roman Hotsiy 2018-03-18 17:55:53 +02:00
parent f993e9b443
commit 03cc781b8d
No known key found for this signature in database
GPG Key ID: 5CB7B3ACABA57CB0
3 changed files with 16 additions and 5 deletions

View File

@ -167,14 +167,14 @@ Here are detailed [options docs](#redoc-options-object).
## ReDoc CLI ## ReDoc CLI
You can use redoc cli by installing `redoc` globally or using [npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b). 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: Twe following commans are available:
- `redoc serve [spec]` - starts the server with `spec` rendered with ReDoc. Supports SSR mode (`--ssr`) and can watch the spec (`--watch`) - `redoc-cli serve [spec]` - starts the server with `spec` rendered with ReDoc. Supports SSR mode (`--ssr`) and can watch the spec (`--watch`)
- `redoc bundle [spec]` - bundles spec and ReDoc into **zero-dependency** HTML file. - `redoc-cli bundle [spec]` - bundles spec and ReDoc into **zero-dependency** HTML file.
For more details run `redoc --help`. For more details run `redoc-cli --help`.
## Configuration ## Configuration

View File

@ -0,0 +1,11 @@
# redoc-cli
**[ReDoc](https://github.com/Rebilly/ReDoc)'s Command Line Interface**
[Documentation](https://github.com/Rebilly/ReDoc/tree/react-rewrite#redoc-cli)
## Installation
TBD
## Usage
TBD

View File

@ -1,6 +1,6 @@
{ {
"name": "redoc-cli", "name": "redoc-cli",
"version": "0.2.0", "version": "0.2.1",
"description": "ReDoc's Command Line Interface", "description": "ReDoc's Command Line Interface",
"main": "index.js", "main": "index.js",
"bin": { "bin": {