Skip to content

Commit c9f9b09

Browse files
authored
Merge pull request #2 from hey-api/chore/package-json
chore: update package.json
2 parents 7a54120 + 8f5531c commit c9f9b09

File tree

3 files changed

+29
-75
lines changed

3 files changed

+29
-75
lines changed

Diff for: LICENSE

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
The MIT License (MIT)
1+
MIT License
22

3-
Copyright (c) 2015 James Messinger
3+
Copyright (c) Hey API
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
99
copies of the Software, and to permit persons to whom the Software is
1010
furnished to do so, subject to the following conditions:
1111

12-
The above copyright notice and this permission notice shall be included in
13-
all copies or substantial portions of the Software.
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
1414

1515
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
1616
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
1717
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21-
THE SOFTWARE.
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Diff for: README.md

+8-40
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,11 @@
44

55
#### Parse, Resolve, and Dereference JSON Schema $ref pointers
66

7-
[![Build Status](https://github.com/APIDevTools/json-schema-ref-parser/workflows/CI-CD/badge.svg?branch=master)](https://github.com/APIDevTools/json-schema-ref-parser/actions)
8-
[![Coverage Status](https://coveralls.io/repos/github/APIDevTools/json-schema-ref-parser/badge.svg?branch=master)](https://coveralls.io/github/APIDevTools/json-schema-ref-parser)
7+
<!-- [![Build Status](https://github.com/APIDevTools/json-schema-ref-parser/workflows/CI-CD/badge.svg?branch=master)](https://github.com/APIDevTools/json-schema-ref-parser/actions)
8+
[![Coverage Status](https://coveralls.io/repos/github/APIDevTools/json-schema-ref-parser/badge.svg?branch=master)](https://coveralls.io/github/APIDevTools/json-schema-ref-parser) -->
99

10-
[![npm](https://img.shields.io/npm/v/@apidevtools/json-schema-ref-parser.svg)](https://www.npmjs.com/package/@apidevtools/json-schema-ref-parser)
11-
[![License](https://img.shields.io/npm/l/@apidevtools/json-schema-ref-parser.svg)](LICENSE)
12-
[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/APIDevTools/json-schema-ref-parser)
10+
<!-- [![npm](https://img.shields.io/npm/v/@apidevtools/json-schema-ref-parser.svg)](https://www.npmjs.com/package/@apidevtools/json-schema-ref-parser)
11+
[![License](https://img.shields.io/npm/l/@apidevtools/json-schema-ref-parser.svg)](LICENSE) -->
1312

1413
## Installation
1514

@@ -58,13 +57,10 @@ complex [JSON Schemas](http://json-schema.org/latest/json-schema-core.html) and
5857
JavaScript objects.
5958

6059
- Use **JSON** or **YAML** schemas &mdash; or even a mix of both!
61-
- Supports `$ref` pointers to external files and URLs, as well
62-
as [custom sources](https://apitools.dev/json-schema-ref-parser/docs/plugins/resolvers.html) such as databases
63-
- Can [bundle](https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#bundlepath-options-callback) multiple
64-
files into a single schema that only has _internal_ `$ref` pointers
65-
- Can [dereference](https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#dereferencepath-options-callback)
66-
your schema, producing a plain-old JavaScript object that's easy to work with
67-
- Supports [circular references](https://apitools.dev/json-schema-ref-parser/docs/#circular-refs), nested references,
60+
- Supports `$ref` pointers to external files and URLs, as well as custom sources such as databases
61+
- Can bundle multiple files into a single schema that only has _internal_ `$ref` pointers
62+
- Can dereference your schema, producing a plain-old JavaScript object that's easy to work with
63+
- Supports circular references, nested references,
6864
back-references, and cross-references between files
6965
- Maintains object reference equality &mdash; `$ref` pointers to the same value always resolve to the same object
7066
instance
@@ -88,8 +84,6 @@ try {
8884
}
8985
```
9086

91-
For more detailed examples, please see the [API Documentation](https://apitools.dev/json-schema-ref-parser/docs/)
92-
9387
## Polyfills
9488

9589
If you are using Node.js < 18, you'll need a polyfill for `fetch`,
@@ -130,16 +124,6 @@ config.plugins.push(
130124
);
131125
```
132126

133-
## API Documentation
134-
135-
Full API documentation is available [right here](https://apitools.dev/json-schema-ref-parser/docs/)
136-
137-
## Contributing
138-
139-
I welcome any contributions, enhancements, and
140-
bug-fixes. [Open an issue](https://github.com/APIDevTools/json-schema-ref-parser/issues) on GitHub
141-
and [submit a pull request](https://github.com/APIDevTools/json-schema-ref-parser/pulls).
142-
143127
#### Building/Testing
144128

145129
To build/test the project locally on your computer:
@@ -152,19 +136,3 @@ To build/test the project locally on your computer:
152136

153137
3. **Run the tests**<br>
154138
`yarn test`
155-
156-
## License
157-
158-
JSON Schema $Ref Parser is 100% free and open-source, under the [MIT license](LICENSE). Use it however you want.
159-
160-
This package is [Treeware](http://treeware.earth). If you use it in production, then we ask that you [**buy the world a
161-
tree**](https://plant.treeware.earth/APIDevTools/json-schema-ref-parser) to thank us for our work. By contributing to
162-
the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
163-
164-
## Big Thanks To
165-
166-
Thanks to these awesome companies for their support of Open Source developers ❤
167-
168-
[![Stoplight](https://svgshare.com/i/TK5.svg)](https://stoplight.io/?utm_source=github&utm_medium=readme&utm_campaign=json_schema_ref_parser)
169-
[![SauceLabs](https://jstools.dev/img/badges/sauce-labs.svg)](https://saucelabs.com)
170-
[![Coveralls](https://jstools.dev/img/badges/coveralls.svg)](https://coveralls.io)

Diff for: package.json

+15-29
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22
"name": "@hey-api/json-schema-ref-parser",
33
"version": "0.0.1",
44
"description": "Parse, Resolve, and Dereference JSON Schema $ref pointers",
5+
"homepage": "https://heyapi.dev/",
6+
"repository": {
7+
"type": "git",
8+
"url": "git+https://github.com/hey-api/json-schema-ref-parser.git"
9+
},
10+
"bugs": {
11+
"url": "https://github.com/hey-api/json-schema-ref-parser/issues"
12+
},
13+
"license": "MIT",
14+
"author": {
15+
"email": "lubos@heyapi.dev",
16+
"name": "Hey API",
17+
"url": "https://heyapi.dev"
18+
},
19+
"funding": "https://github.com/sponsors/hey-api",
520
"keywords": [
621
"json",
722
"schema",
@@ -12,35 +27,6 @@
1227
"dereference",
1328
"resolve"
1429
],
15-
"author": {
16-
"name": "James Messinger",
17-
"url": "https://jamesmessinger.com"
18-
},
19-
"contributors": [
20-
{
21-
"name": "Boris Cherny",
22-
"email": "boris@performancejs.com"
23-
},
24-
{
25-
"name": "Phil Sturgeon",
26-
"email": "phil@apisyouwonthate.com"
27-
},
28-
{
29-
"name": "Jakub Rożek",
30-
"email": "jakub@stoplight.io"
31-
},
32-
{
33-
"name": "JonLuca DeCaro",
34-
"email": "apis@jonlu.ca"
35-
}
36-
],
37-
"homepage": "https://apitools.dev/json-schema-ref-parser/",
38-
"repository": {
39-
"type": "git",
40-
"url": "https://github.com/APIDevTools/json-schema-ref-parser.git"
41-
},
42-
"license": "MIT",
43-
"funding": "https://github.com/sponsors/philsturgeon",
4430
"types": "dist/lib/index.d.ts",
4531
"main": "dist/lib/index.js",
4632
"browser": {

0 commit comments

Comments
 (0)