diff --git a/README.md b/README.md index 5cecbcd68..c4f3454c6 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,16 @@

json-schema-form is a headless UI form library powered by JSON Schemas.
- It transforms JSON schemas into Javascript to be consumed by your UI libraries. + It transforms JSON schemas into Javascript `fields` to be more easily consumed by your UI libraries.

--- ### Why JSON Schemas for forms? -JSON Schemas are the SSoT (Single Source of Truth) that allows you to share form's _structure_ and _validations_ between frontend and backend, regardless of the language used. +JSON Schemas are the SSoT (Single Source of Truth) that allows you to share form's data _structure_ and _validations_ between the server (backend) and the client (frontend), regardless of the language used. + +You can use it beyond UI Forms, like lists, tables, and any other UI that needs structured JSON data. ## Installation @@ -25,12 +27,18 @@ npm install @remoteoss/json-schema-form yarn install @remoteoss/json-schema-form ``` -## Documentation +## Getting Started + +Check the 📚 **[JSF website](https://json-schema-form.vercel.app/)** for documentation. -Check the 📚 **[JSF website](https://json-schema-form.vercel.app/)** for documentation and demos. +### Playground + +Check the đŸ•šī¸ **[JSF Playground](https://json-schema-form.vercel.app/?path=/docs/playground--docs)** for demos. ## Contributing Read [CONTRIBUTING](CONTRIBUTING.md) to get started. +We are working on the [next version v1.0](/next). A rewrite in TypeScript with major bugfixes and missing features. It aims to support the latest JSON Schema dialect 2020-12. + _Backed by [Remote.com](https://remote.com/)_