Docs for version 4.

johnbillion · Aug 21, 2024 · e22658c · e22658c
1 parent a788ddc
commit e22658c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/packages/wp-types/readme.md b/packages/wp-types/readme.md
@@ -180,16 +180,15 @@ npm install wp-types --save-dev
 
 This package is versioned so that you can specify both the schema version and the WordPress branch version in a way that's compatible with semantic versioning. Given version `x.y.z`:
 
-* The major version number (`x`) indicates the schema version number, currently `3`
+* The major version number (`x`) indicates the schema version number, currently `4`
 * The minor version number (`y`) indicates the WordPress branch version number without its decimal place, eg. `66` for WordPress 6.6
 * The patch version number (`z`) indicates the schema patch version number
 
 Examples:
 
-* `~3.66.0` - Schema version 3 for WordPress 6.6
-* `~3.60.0` - Schema version 3 for WordPress 6.0
+* `^4.0.0` - Schema version 4 for the latest WordPress version
+* `~4.66.0` - Schema version 4 for WordPress 6.6
 * `~3.57.0` - Schema version 3 for WordPress 5.7
-* `^3.0.0` - Schema version 3 for the latest WordPress version
 
 ## Usage
 

diff --git a/readme.md b/readme.md
@@ -185,16 +185,21 @@ npm install wp-json-schemas
 
 This package is versioned so that you can specify both the schema version and the WordPress branch version in a way that's compatible with semantic versioning. Given version `x.y.z`:
 
-* The major version number (`x`) indicates the schema version number, currently `3`
+* The major version number (`x`) indicates the schema version number, currently `4`
 * The minor version number (`y`) indicates the WordPress branch version number without its decimal place, eg. `66` for WordPress 6.6
 * The patch version number (`z`) indicates the schema patch version number
 
 Examples:
 
-* `~3.66.0` - Schema version 3 for WordPress 6.6
-* `~3.60.0` - Schema version 3 for WordPress 6.0
+* `^4.0.0` - Schema version 4 for the latest WordPress version
+* `~4.66.0` - Schema version 4 for WordPress 6.6
 * `~3.57.0` - Schema version 3 for WordPress 5.7
-* `^3.0.0` - Schema version 3 for the latest WordPress version
+
+## Breaking changes
+
+If a breaking change needs to be made to the schema then the major version number of this library will be increased.
+
+* Version 4 switched to using JSON Schema `draft/2019-09`. Prior to this, `draft-07` was used.
 
 ## Usage