Skip to content

Commit

Permalink
chore: update redoc-cli docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RomanHotsiy committed Mar 18, 2018
1 parent f993e9b commit 03cc781
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 5 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,14 +167,14 @@ Here are detailed [options docs](#redoc-options-object).

## 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:

- `redoc 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 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 --help`.
For more details run `redoc-cli --help`.

## Configuration

Expand Down
11 changes: 11 additions & 0 deletions cli/README.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion cli/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "redoc-cli",
"version": "0.2.0",
"version": "0.2.1",
"description": "ReDoc's Command Line Interface",
"main": "index.js",
"bin": {
Expand Down

0 comments on commit 03cc781

Please sign in to comment.