Skip to content

Commit 9cd93a1

Browse files
committed
docs: note about v7 in readme
1 parent 877d286 commit 9cd93a1

File tree

1 file changed

+29
-9
lines changed

1 file changed

+29
-9
lines changed

README.md

+29-9
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,39 @@ The fastest JSON Schema validator for Node.js and browser. Supports draft-04/06/
66

77
[![Build Status](https://travis-ci.org/ajv-validator/ajv.svg?branch=master)](https://travis-ci.org/ajv-validator/ajv)
88
[![npm](https://img.shields.io/npm/v/ajv.svg)](https://www.npmjs.com/package/ajv)
9+
[![npm (beta)](https://img.shields.io/npm/v/ajv/beta)](https://www.npmjs.com/package/ajv/v/7.0.0-beta.0)
910
[![npm downloads](https://img.shields.io/npm/dm/ajv.svg)](https://www.npmjs.com/package/ajv)
1011
[![Coverage Status](https://coveralls.io/repos/github/ajv-validator/ajv/badge.svg?branch=master)](https://coveralls.io/github/ajv-validator/ajv?branch=master)
1112
[![Gitter](https://img.shields.io/gitter/room/ajv-validator/ajv.svg)](https://gitter.im/ajv-validator/ajv)
1213
[![GitHub Sponsors](https://img.shields.io/badge/$-sponsors-brightgreen)](https://github.com/sponsors/epoberezkin)
1314

1415

16+
## Ajv v7 beta is released
17+
18+
[Ajv version 7.0.0-beta.0](https://github.com/ajv-validator/ajv/releases/tag/v7.0.0-beta.0) is released with these changes:
19+
20+
- to reduce the mistakes in JSON schemas and unexpected validation results, [strict mode](./docs/strict-mode.md) is added - it prohibits ignored or ambiguous JSON Schema elements.
21+
- to make code injection from untrusted schemas impossible, [code generation](./docs/codegen.md) is fully re-written to be safe.
22+
- to simplify Ajv extensions, the new keyword API that is used by pre-defined keywords is available to user-defined keywords - it is much easier to define any keywords now, especially with subschemas.
23+
- schemas are compiled to ES6 code (ES5 code generation is supported with an option).
24+
- to improve reliability and maintainability the code is migrated to TypeScript.
25+
26+
**Please note**:
27+
28+
- the support for JSON-Schema draft-04 is removed - if you have schemas using "id" attributes you have to replace them with "\$id" (or continue using version 6 that will be supported until 02/28/2021).
29+
- all formats are separated to ajv-formats package - they have to be explicitely added if you use them.
30+
31+
See [release notes](https://github.com/ajv-validator/ajv/releases/tag/v7.0.0-beta.0) for the details.
32+
33+
To install the new version:
34+
35+
```bash
36+
npm install ajv@beta
37+
```
38+
39+
See [Getting started with v7](https://github.com/ajv-validator/ajv/tree/v7-beta#usage) for code example.
40+
41+
1542
## Mozilla MOSS grant and OpenJS Foundation
1643

1744
[<img src="https://www.poberezkin.com/images/mozilla.png" width="240" height="68">](https://www.mozilla.org/en-US/moss/) &nbsp;&nbsp;&nbsp; [<img src="https://www.poberezkin.com/images/openjs.png" width="220" height="68">](https://openjsf.org/blog/2020/08/14/ajv-joins-openjs-foundation-as-an-incubation-project/)
@@ -1449,16 +1476,9 @@ Please see [Contributing guidelines](https://github.com/ajv-validator/ajv/blob/m
14491476

14501477
See https://github.com/ajv-validator/ajv/releases
14511478

1452-
__Please note__: [Changes in version 6.0.0](https://github.com/ajv-validator/ajv/releases/tag/v6.0.0).
1453-
1454-
[Version 5.0.0](https://github.com/ajv-validator/ajv/releases/tag/5.0.0).
1455-
1456-
[Version 4.0.0](https://github.com/ajv-validator/ajv/releases/tag/4.0.0).
1457-
1458-
[Version 3.0.0](https://github.com/ajv-validator/ajv/releases/tag/3.0.0).
1459-
1460-
[Version 2.0.0](https://github.com/ajv-validator/ajv/releases/tag/2.0.0).
1479+
__Please note__: [Changes in version 7.0.0-beta](https://github.com/ajv-validator/ajv/releases/tag/v7.0.0-beta.0)
14611480

1481+
[Version 6.0.0](https://github.com/ajv-validator/ajv/releases/tag/v6.0.0).
14621482

14631483
## Code of conduct
14641484

0 commit comments

Comments
 (0)