Skip to content

Commit

Permalink
Keywords and links
Browse files Browse the repository at this point in the history
  • Loading branch information
tschaub committed Mar 17, 2024
1 parent 19e8c31 commit af4a800
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
"type": "git",
"url": "git://github.com/geojson/schema.git"
},
"keywords": [
"geojson",
"schema"
],
"license": "MIT",
"type": "module",
"scripts": {
Expand Down
6 changes: 5 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ See JSON Schema docs for the GeoJSON types below:
The overall GeoJSON schema can be found at
* [`GeoJSON`](https://geojson.org/schema/GeoJSON.json)

The schema files are also published to the [`geojson-schema` package](https://www.npmjs.com/package/geojson-schema) on npm. You can add them as a dependency to your project with the following:

npm install geojson-schema

## Limitations

The schema can not be used to validate that linear rings are closed or that they follow the right-hand rule. These two elements of the [GeoJSON specification](https://datatracker.ietf.org/doc/html/rfc7946) cannot be represented in JSON Schema. To enforce these two elements of linear ring validation, parsers must implement their own logic on top of JSON Schema validation.
Expand All @@ -39,7 +43,7 @@ A CI job builds commits pushed to `main`. After a successful build, artifacts a

# Publishing

To publish the `geojson-schema` package, run the following:
To publish the [`geojson-schema` package](https://www.npmjs.com/package/geojson-schema), run the following:

npm version minor # or major or patch
make build
Expand Down

0 comments on commit af4a800

Please sign in to comment.