Skip to content

Commit

Permalink
Add documentation on limitations
Browse files Browse the repository at this point in the history
  • Loading branch information
tschaub committed Sep 8, 2021
1 parent 660d67d commit 3987466
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,22 @@ See JSON Schema docs for the GeoJSON types below:
The overall GeoJSON schema can be found at
* [`GeoJSON`](http://geojson.org/schema/GeoJSON.json)

# build
## 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.

# Development

Install dependencies:

npm install

To build the schema docs:

make

The output will be in the `build` directory.

# deploy

A CI job builds commits pushed to `main`. After a successful build, artifacts are pushed to the `gh-pages` branch and will be accessible at geojson.org/schema/<name>.json (e.g. http://geojson.org/schema/Point.json).

[![Build Status](https://github.com/geojson/schema/workflows/Deploy/badge.svg)](https://github.com/geojson/schema/actions?workflow=Deploy)

0 comments on commit 3987466

Please sign in to comment.