From 60ba50459745cce81991823a25df7614855e47e1 Mon Sep 17 00:00:00 2001 From: Jan-Luca Klees Date: Thu, 12 Mar 2020 08:49:30 +0100 Subject: [PATCH] Added note about supported Draft versions When I got started working with this library I got frustrated when my Schema didn't work as expected. It wasn't until I looked at the test files that I realized I was using features of a Draft that was not supported by this library. A note like the one I added would have saved me a lot of time trying to debug my Schema. So I am adding it now for everyone that comes after me. --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 433da7a3..26060a57 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Latest Stable Version](https://poser.pugx.org/justinrainbow/json-schema/v/stable.png)](https://packagist.org/packages/justinrainbow/json-schema) [![Total Downloads](https://poser.pugx.org/justinrainbow/json-schema/downloads.png)](https://packagist.org/packages/justinrainbow/json-schema) -A PHP Implementation for validating `JSON` Structures against a given `Schema`. +A PHP Implementation for validating `JSON` Structures against a given `Schema` with support for `Schemas` of Draft-3 or Draft-4. Features of newer Drafts might not be supported. See [Table of All Versions of Everything](https://json-schema.org/specification-links.html#table-of-all-versions-of-everything) to get an overview of all existing Drafts. See [json-schema](http://json-schema.org/) for more details. @@ -26,6 +26,12 @@ composer require justinrainbow/json-schema ## Usage +For a complete reference see [Understanding JSON Schema](https://json-schema.org/understanding-json-schema/). + +__Note:__ features of Drafts newer than Draft-4 might not be supported! + +### Basic usage + ```php