Skip to content

chore(README): Better explain JSF, mention the Playground and next version v1 #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 28, 2025
Merged

chore(README): Better explain JSF, mention the Playground and next version v1 #192

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99563dc
chore(README): Mention other UIs besides forms, mention the Playgroun…
sandrina-p May 28, 2025
f5bc99f
self review
sandrina-p May 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@
<p align="center">
<code>json-schema-form</code> is a headless UI form library powered by <a href="https://json-schema.org/">JSON Schemas</a>.
<br/>
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.
</p>

---

### 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

Expand All @@ -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/)_