diff --git a/README.md b/README.md index d03c456..6088723 100644 --- a/README.md +++ b/README.md @@ -13,21 +13,6 @@ Niels Lohmann et al develop a great JSON parser for C++ called [JSON for Modern C++](https://github.com/nlohmann/json). This validator is based on this library, hence the name. -## New in version 2 - -Although significant changes have been done for the 2nd version -(a complete rewrite) the API is compatible with the 1.0.0 release. Except for -the namespace which is now `nlohmann::json_schema`. - -Version **2** supports JSON schema draft 7, whereas 1 was supporting draft 4 -only. Please update your schemas. - -The primary change in 2 is the way a schema is used. While in version 1 the schema was -kept as a JSON-document and used again and again during validation, in version 2 the schema -is parsed into compiled C++ objects which are then used during validation. There are surely -still optimizations to be done, but validation speed has improved by factor 100 -or more. - ## Design goals The main goal of this validator is to produce *human-comprehensible* error diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..b0c7ba8 --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,16 @@ +# Changelog + +## New in version 2 + +Although significant changes have been done for the 2nd version +(a complete rewrite) the API is compatible with the 1.0.0 release. Except for +the namespace which is now `nlohmann::json_schema`. + +Version **2** supports JSON schema draft 7, whereas 1 was supporting draft 4 +only. Please update your schemas. + +The primary change in 2 is the way a schema is used. While in version 1 the schema was +kept as a JSON-document and used again and again during validation, in version 2 the schema +is parsed into compiled C++ objects which are then used during validation. There are surely +still optimizations to be done, but validation speed has improved by factor 100 +or more. diff --git a/docs/index.md b/docs/index.md index 2c06ce8..ef50137 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,6 +9,7 @@ glob: true hidden: true --- CONTRIBUTING +changelog ::: :::{include} ../README.md