From 3987466fb2dc311b6668ecd69ec00627e87c410b Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Wed, 8 Sep 2021 15:24:51 -0600 Subject: [PATCH] Add documentation on limitations --- readme.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index ec14c4b..555faf5 100644 --- a/readme.md +++ b/readme.md @@ -17,7 +17,15 @@ 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: @@ -25,8 +33,6 @@ To build the schema docs: 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/.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)