Skip to content

Commit 76d2e3c

Browse files
authored
docs(readme): spelling and grammar fixes (#21)
Signed-off-by: Frazer Smith <frazer.dev@icloud.com>
1 parent b7be7c3 commit 76d2e3c

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# json-schema-ref-resolver
22

3+
[![CI](https://github.com/fastify/json-schema-ref-resolver/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/fastify/json-schema-ref-resolver/actions/workflows/ci.yml)
4+
[![npm version](https://img.shields.io/npm/v/json-schema-ref-resolver)](https://www.npmjs.com/package/json-schema-ref-resolver)
5+
[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)
6+
37
__json-schema-ref-resolver__ is a javascript library that resolves references in [JSON schemas](https://json-schema.org/draft/2020-12/json-schema-core#name-introduction).
48

59
- [Installation](#installation)
@@ -255,7 +259,7 @@ assert.deepStrictEqual(dependencies, { targetSchema1, targetSchema2 })
255259

256260
#### derefSchema(schemaId)
257261

258-
Dereferences all references in the schema. All dependency also will be dereferenced. If schema with the specified id is not found, an error will be thrown.
262+
Dereferences all references in the schema. All dependencies will also be dereferenced. If schema with the specified id is not found, an error will be thrown.
259263

260264
- `schemaId` __\<string\>__ - schema id of the schema to dereference.
261265

@@ -361,7 +365,7 @@ assert.deepStrictEqual(derefSourceSchema, {
361365

362366
#### Caveats
363367

364-
- If a reference schema and a source schema have a key with the same name and different values, an error will be throwing during a call to `derefSchema` or `getDerefSchema`.
368+
- If a reference schema and a source schema have a key with the same name and different values, an error will be thrown during a call to `derefSchema` or `getDerefSchema`.
365369

366370
_Example:_
367371

@@ -396,3 +400,7 @@ refResolver.addSchema(sourceSchema)
396400

397401
refResolver.derefSchema('sourceSchema') // Throws an error
398402
```
403+
404+
## License
405+
406+
Licensed under [MIT](./LICENSE).

0 commit comments

Comments
 (0)