From 03cc781b8d2c223c97d9b3955322662b879f0266 Mon Sep 17 00:00:00 2001 From: Roman Hotsiy Date: Sun, 18 Mar 2018 17:55:53 +0200 Subject: [PATCH] chore: update redoc-cli docs --- README.md | 8 ++++---- cli/README.md | 11 +++++++++++ cli/package.json | 2 +- 3 files changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e5cd4b2a..92c6c6e7 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/cli/README.md b/cli/README.md index e69de29b..31bf8398 100644 --- a/cli/README.md +++ b/cli/README.md @@ -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 \ No newline at end of file diff --git a/cli/package.json b/cli/package.json index e223f0d1..4f52c4b6 100644 --- a/cli/package.json +++ b/cli/package.json @@ -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": {