diff --git a/README.md b/README.md index 5be5df40..b503805d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # Digital Planning Data schemas -This repository contains [JSON schemas](https://json-schema.org/) to describe Digital Planning services developed by [Open Digital Planning](https://opendigitalplanning.org/). +This repository contains data specifications to describe Digital Planning services developed by [Open Digital Planning](https://opendigitalplanning.org/). Each specification is communicated via a [JSON Schema](https://json-schema.org/) document. -Our initial schema defines data structures, rules, and validation logic for planning applications - including Lawful Development Certificate, Prior Approval, and Planning Permission services - that are being designed and submitted via [PlanX](https://www.planx.uk/). +Our initial specification defines data structures, rules, and validation logic for planning applications - including Lawful Development Certificate, Prior Approval, and Planning Permission services - that are being designed and submitted via [PlanX](https://www.planx.uk/). -Digital Planning Data schemas aim to encourage more interoperability and consistency between systems by offering a central, version controlled standard for documenting and validating planning data. +Digital Planning Data schemas aim to encourage more interoperability and consistency between systems by offering a central, version controlled specification for documenting and validating planning data. Going forward, we hope that this repository will expand beyond applications to further describe planning reference numbers, site notices, consultations, and more. @@ -14,19 +14,19 @@ There's two main options for integrating with Digital Planning Data schemas: `http://theopensystemslab.github.io/digital-planning-data-schemas//schema.json` -1. Clone this repository and reference the local schema files programmatically in your own code using tools that support JSON schema validation +1. Clone this repository and reference the local schema files programmatically in your own code using tools that support JSON Schema validation For more detailed info on integrating and validating schemas, please refer to the examples and tests in this repo. ## Repository structure -`/examples`: Examples of valid payloads for each application type supported by the JSON schema +`/examples`: Examples of valid payloads for each application type supported by this specification. -`/schema`: The main JSON schema file. The `main` branch of this repo will reflect the `@next` version, while historic versions are documented and released on the `dist` branch. +`/schema`: The main JSON Schema file. The `main` branch of this repo will reflect the `@next` version, while historic versions are documented and released on the `dist` branch. -`/types`: TypeScript interfaces used to generate the JSON schema. +`/types`: TypeScript interfaces used to generate the JSON Schema. -`/tests`: Test suites to ensure that the generated schemas and example payloads are valid, accurate, and capable of handling different scenarios. +`/tests`: Test suites to ensure that the generated schema and example payloads are valid, accurate, and capable of handling different scenarios. ## Installation @@ -37,7 +37,7 @@ pnpm i ``` ## Developing -The JSON schema is defined using TypeScript interfaces and then generated using the `ts-json-schema-generator` library. +The JSON Schema is defined using TypeScript interfaces and then generated using the `ts-json-schema-generator` library. To make changes, update `/types` and then run `pnpm build` to automatically generate the output JSON file under `/schema`.