Skip to content
This repository has been archived by the owner on Jan 22, 2024. It is now read-only.

Update README.md #12

Merged
merged 1 commit into from
Jan 22, 2024
Merged
Changes from all commits
Commits
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
44 changes: 1 addition & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1 @@
<p align="center">
<img src="./assets/cover.svg" />
<br />
</p>
<p align="center">
<a href="#what-is-this-">What is this?</a> •
<a href="#features-">Features</a> •
<a href="#installation-">Installation</a> •
<a href="#documentation-">Documentation</a> •
<a target="_blank" href="https://reform-demo.rescriptbrasil.org">Live demo (with ReForm)</a>
</p>
<br/>

## What is this? 💡
ReSchema is a schema builder for ReScript. We created ReSchema to be deadly simple, leveraging ReScript's powerful typesytem.
Schemas created with ReSchema are nothing more than constructors built-in in the language itself with a small size footprint.

## Features ⚡
- Schema validation using GADT's
- Built-in validators
- Type-safe validation
- I18n support
- Regex support
- Custom validations

## Installation 📦

```sh
yarn add @rescriptbr/reschema
```
and then, add `ReSchema` as a dependency in your `bsconfig.json`
```js
{
...
"bs-dependencies": [
"@rescriptbr/reschema"
],
}
```

## Documentation 🔎
- [Getting Started](./docs/1-getting-started.md)
- [API Reference](./docs/2-api-reference.md)
# This has been moved to the [ReForm monorepo](https://github.com/rescriptbr/reform/tree/master/packages/reschema)
Loading