Skip to content

Commit d1cd88b

Browse files
author
Phil Sturgeon
committed
Make note about $ref more prominent
Closes #5
1 parent 035a16f commit d1cd88b

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ The example prints out
4444
}
4545
```
4646

47+
**NOTE**: `$ref`s are not dereferenced. Use a dereferencer such as [json-schema-ref-parser](https://www.npmjs.com/package/json-schema-ref-parser) prior to using this package.
48+
4749
### Options
4850

4951
The function accepts `options` object as the second argument.
@@ -78,9 +80,6 @@ _† Draft v5 is also known as Draft Wright 00, as the drafts are often named af
7880

7981
To convert the other way, check out [openapi-schema-to-json-schema], which this package was based on.
8082

81-
**NOTE**: `$ref`s are not dereferenced. Use a dereferencer such as [json-schema-ref-parser](https://www.npmjs.com/package/json-schema-ref-parser) prior to using this package.
82-
83-
8483
## Tests
8584

8685
To run the test-suite:

0 commit comments

Comments
 (0)