This repository has been archived by the owner on Jan 22, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #12 from rescriptbr/fakenickels-patch-1
Update README.md
- Loading branch information
Showing
1 changed file
with
1 addition
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |