Skip to content

Commit 6309aec

Browse files
authored
Update README.md
1 parent 2df8367 commit 6309aec

File tree

1 file changed

+26
-21
lines changed

1 file changed

+26
-21
lines changed

README.md

+26-21
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,29 @@
1+
### How to install
2+
```
3+
npm install -g [email protected]
4+
```
5+
6+
### Command Usage
7+
```
8+
vishrut@visshamac openapi-diff $ oad compare --help
9+
Commands:
10+
compare <old-spec> <new-spec> Compares old and new open api specification for
11+
breaking changes.
12+
13+
Options:
14+
--version Show version number [boolean]
15+
-l, --logLevel Set the logging level for console.
16+
[choices: "off", "json", "error", "warn", "info", "verbose", "debug", "silly"]
17+
[default: "warn"]
18+
-f, --logFilepath Set the log file path. It must be an absolute filepath. By
19+
default the logs will stored in a timestamp based log file
20+
at "/Users/vishrut/oad_output".
21+
-j, --inJson A boolean flag indicating whether output format of the
22+
messages is json. [boolean] [default: true]
23+
-h, --help Show help [boolean]
24+
25+
```
26+
127
## Build dependencies
228
- [Node](https://nodejs.org) (6.9.5 or higher)
329
- [Node Package Manager](https://www.npmjs.com/package/npm)
@@ -26,27 +52,6 @@ gulp pack
2652
npm install -g oad-0.1.0.tgz
2753
```
2854

29-
### Command Usage
30-
```
31-
vishrut@visshamac openapi-diff $ oad compare --help
32-
Commands:
33-
compare <old-spec> <new-spec> Compares old and new open api specification for
34-
breaking changes.
35-
36-
Options:
37-
--version Show version number [boolean]
38-
-l, --logLevel Set the logging level for console.
39-
[choices: "off", "json", "error", "warn", "info", "verbose", "debug", "silly"]
40-
[default: "warn"]
41-
-f, --logFilepath Set the log file path. It must be an absolute filepath. By
42-
default the logs will stored in a timestamp based log file
43-
at "/Users/vishrut/oad_output".
44-
-j, --inJson A boolean flag indicating whether output format of the
45-
messages is json. [boolean] [default: true]
46-
-h, --help Show help [boolean]
47-
48-
```
49-
5055
# Contributing
5156

5257
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

0 commit comments

Comments
 (0)