Skip to content

Commit 91cf675

Browse files
authored
Update README
1 parent 35385bc commit 91cf675

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# nem2-openapi-generator-dart
2-
This is an OpenAPI generator for Dart (v2 and above) which allow generation of NEM2 API client libraries for NEM2 SDK Dart ([nem2-sdk-dart][nem2-sdk-dart-repo]) automatically given a NEM2 OpenAPI Spec ([nem2-openapi][nem2-openapi-spec-repo]).
2+
This is an OpenAPI generator for Dart (v2 and above) which allows generation of NEM2 API client libraries for NEM2 SDK Dart ([nem2-sdk-dart][nem2-sdk-dart-repo]) automatically given a NEM2 OpenAPI Spec ([nem2-openapi][nem2-openapi-spec-repo]).
33

44
## Requirements
55
An [OpenAPI Generator CLI][openapi-generator-cli-docs] for your Operating System is required to generate the client libraries.
66
The code generation script uses Homebrew by default and it will install the openapi-generator-cli when it has not been installed.
77

8-
If you want to install and use the OpenAPI generator without using Homebrew, then you can disable the line inside the generator script that checks and installs it.
8+
If you want to install and use the OpenAPI generator without using Homebrew, then you can disable the line inside the code generation script that checks and installs it.
99

1010
## Usage
11-
Run the generator script:
11+
Run the code generation script:
1212
```$bash
1313
./generate.sh
1414
```
1515

1616
## Configuration
17-
The generator uses a custom configuration file `openapi-config.yaml` available for Dart. Please refer to the following page for a complete list of config options: [here][openapi-genrator-dart2-configs].
17+
The OpenAPI generator uses a custom configuration file `openapi-config.yaml` available for Dart. Please refer to the following page for a complete list of config options: [here][openapi-genrator-dart2-configs].
1818

1919
## Version
2020
This project is updated for NEM2 OpenAPI specification version [0.7.20][nem2-openapi-spec-file].

0 commit comments

Comments
 (0)