From 5506bfc58edda6d96206f56b56a55b6182a4cc24 Mon Sep 17 00:00:00 2001 From: sinclairzx81 Date: Fri, 15 Jun 2018 05:04:56 +1200 Subject: [PATCH] typebox-v2 --- readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 95cc681..c491ca7 100644 --- a/readme.md +++ b/readme.md @@ -30,9 +30,9 @@ console.log(Foo) ## overview -TypeBox is a type builder which allows developers to compose JSON schema objects and allow these objects to be statically resolved as TypeScript types. The aim of this project is to find parity with respect to the TypeScript type checker and JSON schema, allowing for runtime type verification for objects that line up to TypeScript types (at design time) +typebox is a type builder which allows developers to compose json schema objects and allow these json schema objects to be statically resolved as TypeScript types. The aim of this project is to find parity with respect to the TypeScript type checker and JSON schema, allowing for runtime type verification using standard json schema validation that lines up to TypeScripts structural type checker. -typebox doesn't come with a JSON schema validator and is only concerned with generating valid JSON schema. Recommend the `ajv` library. +note: typebox doesn't is only concerned with generating valid JSON schema and static resolution and does not come with a JSON schema validator. For JSON schema validation, recommend the `ajv` library for JavaScript. ## usage