Skip to content

Commit c455091

Browse files
authored
docs(readme): grammar fixes
Signed-off-by: Frazer Smith <[email protected]>
1 parent c75f48b commit c455091

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,5 +1,9 @@
11
# openapi-schema-diff
22

3+
[![CI](https://github.com/fastify/openapi-schema-diff/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/fastify/openapi-schema-diff/actions/workflows/ci.yml)
4+
[![npm version](https://img.shields.io/npm/v/openapi-schema-diff)](https://www.npmjs.com/package/openapi-schema-diff)
5+
[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)
6+
37
__openapi-schema-diff__ is a javascript library that compares two OpenAPI schemas and finds breaking changes.
48

59
- [Installation](#installation)
@@ -13,7 +17,7 @@ __openapi-schema-diff__ is a javascript library that compares two OpenAPI schema
1317
## Installation
1418

1519
```bash
16-
npm install openapi-schema-diff
20+
npm i openapi-schema-diff
1721
```
1822

1923
<a name="usage"></a>
@@ -198,9 +202,9 @@ Compares two OpenAPI schemas and returns and finds breaking changes. Source and
198202
- `sourceSchema` __\<object\>__ - source OpenAPI schema of the component.
199203
- `targetSchema` __\<object\>__ - target OpenAPI schema of the component.
200204
- `comment` __\<string\>__ - a comment describing the change.
201-
- `changes` __\<array\>__ - a list of changes in a component json schema. Exist only if `action` equals to `changed`. Each schema keyword has it's own change object. See [list of change objects](#list-schema-keywords-and-their-change-objects).
205+
- `changes` __\<array\>__ - a list of changes in a component json schema. Exist only if `action` equals to `changed`. Each schema keyword has its own change object. See [list of change objects](#list-schema-keywords-and-their-change-objects).
202206

203-
Each of the route components has it's own unique properties that identify it. For more details look at the component change object: [parameter](#parameter-change-object), [request body](#request-body-change-object), [response body](#response-body-change-object), [response header](#response-header-change-object).
207+
Each of the route components has its own unique properties that identify it. For more details look at the component change object: [parameter](#parameter-change-object), [request body](#request-body-change-object), [response body](#response-body-change-object), [response header](#response-header-change-object).
204208

205209
##### Parameter change object
206210

@@ -258,4 +262,4 @@ Each of the route components has it's own unique properties that identify it. Fo
258262

259263
## License
260264

261-
MIT
265+
Licensed under [MIT](./LICENSE).

0 commit comments

Comments
 (0)