Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HugoRodriguesQW committed Jul 20, 2023
1 parent 0ab3af5 commit 32a0833
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,31 @@
## schema.js

[![CI](https://github.com/HugoRodriguesQW/schema/actions/workflows/main.yml/badge.svg)](https://github.com/HugoRodriguesQW/schema/actions/workflows/main.yml)
[![V](https://img.shields.io/npm/v/@hugorodriguesqw/mini-schema)](https://www.npmjs.com/package/@hugorodriguesqw/mini-schema)
[![A](https://img.shields.io/github/commit-activity/m/hugorodriguesqw/schema)](https://github.com/HugoRodriguesQW/schema/graphs/commit-activity)
[![P](https://img.shields.io/github/package-json/name/hugorodriguesqw/schema?label=npm&color=purple)](https://www.npmjs.com/package/@hugorodriguesqw/mini-schema)
[![L](https://img.shields.io/github/package-json/license/hugorodriguesqw/schema?color=purple)](https://github.com/HugoRodriguesQW/schema/blob/main/LICENSE)
[![C](https://img.shields.io/github/contributors/hugorodriguesqw/schema)](https://github.com/HugoRodriguesQW/schema/graphs/contributors)

A proof of concept schema validator for javascript. It's quite usual, so much so that I'm using it as a validator for my neural network setup.

<a id='usage'></a>

#### #Instalation

- using npm `npm install @hugorodriguesqw/mini-schema`
- using npm:

```js
import { Schema, SchemaItem } from '@hugorodriguesqw/mini-schema'
```
npm install @hugorodriguesqw/mini-schema
```

- using yarn `yarn install @hugorodriguesqw/mini-schema`
- using yarn:

```js
import { Schema, SchemaItem } from '@hugorodriguesqw/mini-schema'
```
yarn install @hugorodriguesqw/mini-schema
```

- using unpkg `https://unpkg.com/@hugorodriguesqw/mini-schema@latest/schema.js`
- using unpkg:

```html
<script src="https://unpkg.com/@hugorodriguesqw/mini-schema@latest/schema.js"></script>
Expand All @@ -27,6 +34,8 @@ import { Schema, SchemaItem } from '@hugorodriguesqw/mini-schema'
#### #Usage

```js
import {Schema, SchemaItem} from '@hugorodriguesqw/mini-schema'

const schema = new Schema({ ... SchemaItem ... })

schema.validate({ data }).then().catch()
Expand Down

0 comments on commit 32a0833

Please sign in to comment.