Skip to content

Commit 642c2e8

Browse files
committed
Readme adjustment
1 parent 4c5db43 commit 642c2e8

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Raml Toolkit <!-- omit in toc -->
22

3-
A collection of raml an OAS tools for commerce cloud and beyond
3+
A collection of RAML and OAS tools for commerce cloud and beyond
4+
5+
**Note:** Running some OAS commands requires that oasdiff is installed. Install oasdiff according to https://github.com/oasdiff/oasdiff#installation
46

57
[![CircleCI][circleci-image]][circleci-url]
68

@@ -42,6 +44,7 @@ Npm installs the binaries as both `raml-toolkit` and `ramlint` and they can be u
4244

4345
A wrapper command for `openapi-generator-cli generate`
4446

47+
```txt
4548
USAGE
4649
$ raml-toolkit generate -i OAS_spec_file -o output_dir -t templates_dir
4750
@@ -58,12 +61,13 @@ OPTIONS
5861
-g, --generator The generator. Defaults to `typescript-fetch`
5962
6063
--skipValidateSpec Generate API without validating the spec. Defaults to false.
61-
64+
```
6265

6366
#### `raml-toolkit diff BASE NEW -s oas`
6467

65-
**Note:** This command requires that oasdiff is. installed. Install oasdiff according to https://github.com/oasdiff/oasdiff#installation
68+
**Note:** This command requires that oasdiff is installed. Install oasdiff according to https://github.com/oasdiff/oasdiff#installation
6669

70+
```txt
6771
USAGE
6872
$ raml-toolkit diff BASE NEW -s oas
6973
@@ -80,7 +84,7 @@ OPTIONS
8084
--dir Find the differences for files in two directory trees
8185
8286
-s, --spec Toggles OAS mode. Set this to `oas`. Otherwise, the command will run the RAML version
83-
87+
```
8488

8589
### Commands for RAML
8690

0 commit comments

Comments
 (0)