Skip to content

Commit 94bd6e8

Browse files
authored
docs: fix typos in readme documents (#89)
Signed-off-by: peefy <[email protected]>
1 parent fba48bd commit 94bd6e8

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Coverage Status](https://coveralls.io/repos/github/kcl-lang/kcl-openapi/badge.svg)](https://coveralls.io/github/kcl-lang/kcl-openapi)
66

77
The work on this project is mainly based on [go-swagger](https://github.com/go-swagger/go-swagger), and this project just adds some
8-
KCL-specific templates and language features on it. We are grateful and sincerely respectful for the outstanding work
8+
KCL-specific templates and language features to it. We are grateful and sincerely respectful for the outstanding work
99
in [go-swagger](https://github.com/go-swagger/go-swagger). Meanwhile, we are working on making the customized features separated from the
1010
basic OpenAPI logic in go-swagger.
1111

@@ -24,7 +24,7 @@ The kcl-openapi tool can be installed in both ways:
2424

2525
- [go install](#1-go-install)
2626
- [curl|sh install (MacOS & Linux)](#2-curlsh-install-macos--linux)
27-
- [download from release](#3-dowload-from-release)
27+
- [download from release](#3-download-from-release)
2828

2929
## 1 go install
3030

@@ -34,20 +34,20 @@ The kcl-openapi tool can be installed in both ways:
3434

3535
## 2 Curl|sh install (MacOS & Linux)
3636

37-
If you don't have go, you can install the CLI with this one-liner:
37+
If you don't have to go, you can install the CLI with this one-liner:
3838

3939
```shell
4040
curl -fsSL https://kcl-lang.io/script/install-kcl-openapi.sh | /bin/bash
4141
```
4242

43-
## 3 Dowload from release
43+
## 3 Download from release
4444

4545
```shell
4646
# 1. download the released binary from:
4747
# https://github.com/kcl-lang/kcl-openapi/releases
4848

4949
# 2. Unzip the package and add the binary location to PATH
50-
export PATH="<Your directory to store KCLOpenapi binary>:$PATH"
50+
export PATH="<Your directory to store KCLOpenAPI binary>:$PATH"
5151
```
5252

5353
## Features
@@ -72,7 +72,7 @@ Alternatively, if you may want to generate them yourself, please refer [Generate
7272

7373
The tool can also translate
7474
the [Kubernetes CRD](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/) to KCL models.
75-
By parsing the spec.versions[n].schema.openAPIV3Schema (n means the latest version of the spec will be used) section of the CRD, the KCL
75+
By parsing the `spec.versions[n].schema.openAPIV3Schema` (n means the latest version of the spec will be used) section of the CRD, the KCL
7676
OpenAPI tool will extract the structural schema and generate the corresponding KCL representation.
7777

7878
The command is as follows:
@@ -83,8 +83,7 @@ The command is as follows:
8383

8484
## KCL OpenAPI Spec
8585

86-
The [KCL OpenAPI Spec](https://kcl-lang.io/docs/reference/cli/openapi/spec) defines a complete specification of how OpenAPI objects are
87-
mapping to KCL language elements.
86+
The [KCL OpenAPI Spec](https://kcl-lang.io/docs/reference/cli/openapi/spec) defines a complete specification of how OpenAPI objects are mapped to KCL language elements.
8887

8988
## Ask for help
9089

0 commit comments

Comments
 (0)