Skip to content

Commit 4e2fdd5

Browse files
author
Fuss Florian (uid10804)
committed
docs(cli): update command descriptions
1 parent 014ed78 commit 4e2fdd5

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

packages/cli/README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
json-serverless
2-
===============
1+
# json-serverless
32

43
cli for json-serverless project
54

@@ -9,11 +8,15 @@ cli for json-serverless project
98
[![License](https://img.shields.io/npm/l/json-serverless.svg)](https://github.com/pharindoko/json-serverless/blob/master/package.json)
109

1110
<!-- toc -->
12-
* [Usage](#usage)
13-
* [Commands](#commands)
11+
12+
- [Usage](#usage)
13+
- [Commands](#commands)
1414
<!-- tocstop -->
15+
1516
# Usage
17+
1618
<!-- usage -->
19+
1720
```sh-session
1821
$ npm install -g json-serverless
1922
$ jsonsls COMMAND
@@ -25,14 +28,18 @@ USAGE
2528
$ jsonsls COMMAND
2629
...
2730
```
31+
2832
<!-- usagestop -->
33+
2934
# Commands
35+
3036
<!-- commands -->
31-
* [`jsonsls create-stack FILE [STAGE]`](#jsonsls-create-stack-file-stage)
32-
* [`jsonsls help [COMMAND]`](#jsonsls-help-command)
33-
* [`jsonsls run FILE`](#jsonsls-run-file)
34-
* [`jsonsls update-stack [STAGE]`](#jsonsls-update-stack-stage)
35-
* [`jsonsls validate FILE`](#jsonsls-validate-file)
37+
38+
- [`jsonsls create-stack FILE [STAGE]`](#jsonsls-create-stack-file-stage)
39+
- [`jsonsls help [COMMAND]`](#jsonsls-help-command)
40+
- [`jsonsls run FILE`](#jsonsls-run-file)
41+
- [`jsonsls update-stack [STAGE]`](#jsonsls-update-stack-stage)
42+
- [`jsonsls validate FILE`](#jsonsls-validate-file)
3643

3744
## `jsonsls create-stack FILE [STAGE]`
3845

@@ -84,7 +91,7 @@ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0
8491

8592
## `jsonsls run FILE`
8693

87-
run and test the api locally
94+
run and develop with the api locally
8895

8996
```
9097
USAGE
@@ -137,7 +144,7 @@ _See code: [lib/commands/update-stack.js](https://github.com/pharindoko/json-ser
137144

138145
## `jsonsls validate FILE`
139146

140-
describe the command here
147+
validate the json file to see if it works with json-serverless
141148

142149
```
143150
USAGE
@@ -152,4 +159,5 @@ OPTIONS
152159
```
153160

154161
_See code: [lib/commands/validate.js](https://github.com/pharindoko/json-serverless/blob/v1.6.0/lib/commands/validate.js)_
162+
155163
<!-- commandsstop -->

0 commit comments

Comments
 (0)