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

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fakenickels authored Jan 22, 2024
1 parent 4b8ebe5 commit f7cd0f4
Showing 1 changed file with 1 addition and 43 deletions.
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)

0 comments on commit f7cd0f4

Please sign in to comment.