Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Julien-R44 committed Jan 28, 2024
1 parent 03754d1 commit fe08b54
Showing 1 changed file with 13 additions and 41 deletions.
54 changes: 13 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,15 @@

<br />

<div align="center">

![](./benchmarks.jpeg)

</div>

[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![synk-image]][synk-url]
[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url]

## Introduction
AdonisJS validator is a type-safe schema validation library to validate form requests. It is one of the **fastest validation** library in the Node.js ecosystem.
This is the repo for the legacy Validator mainly used by AdonisJS v5. We ported it to AdonisJS 6 in order to allow users to easily migrate to AdonisJS 6.

The new validator is now [Vine.js](vinejs.dev) and we recommend migrating to it and using it for new projects.

## Official Documentation
The documentation is available on the [AdonisJS website](https://docs.adonisjs.com/guides/validator/introduction)
The documentation for the legacy validator is available on the [AdonisJS website](https://v6-migration.adonisjs.com/guides/validator-introduction)

## Contributing
One of the primary goals of AdonisJS is to have a vibrant community of users and contributors who believes in the principles of the framework.
Expand All @@ -25,39 +21,15 @@ We encourage you to read the [contribution guide](https://github.com/adonisjs/.g
In order to ensure that the AdonisJS community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/adonisjs/.github/blob/main/docs/CODE_OF_CONDUCT.md).

## License
AdonisJS validator is open-sourced software licensed under the [MIT license](LICENSE.md).

<div align="center">
<h3>
<a href="https://adonisjs.com">
Website
</a>
<span> | </span>
<a href="https://docs.adonisjs.com/guides/validator/introduction">
Guides
</a>
<span> | </span>
<a href="CONTRIBUTING.md">
Contributing
</a>
</h3>
</div>

<div align="center">
<sub>Built with ❤︎ by <a href="https://twitter.com/AmanVirk1">Harminder Virk</a>
</div>

[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/validator/test.yml?style=for-the-badge
[gh-workflow-url]: https://github.com/adonisjs/validator/actions/workflows/test.yml "Github action"
AdonisJS Mail is open-sourced software licensed under the [MIT license](LICENSE.md).

[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
[typescript-url]: "typescript"
[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/validator/checks.yml?style=for-the-badge
[gh-workflow-url]: https://github.com/adonisjs/validator/actions/workflows/checks.yml "Github action"

[npm-image]: https://img.shields.io/npm/v/@adonisjs/validator/alpha.svg?style=for-the-badge&logo=npm
[npm-url]: https://npmjs.org/package/@adonisjs/validator/v/alpha "npm"
[npm-image]: https://img.shields.io/npm/v/@adonisjs/validator/latest.svg?style=for-the-badge&logo=npm
[npm-url]: https://www.npmjs.com/package/@adonisjs/validator/v/latest "npm"

[license-image]: https://img.shields.io/npm/l/@adonisjs/validator?color=blueviolet&style=for-the-badge
[license-url]: LICENSE.md "license"
[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript

[synk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs/validator?label=Synk%20Vulnerabilities&style=for-the-badge
[synk-url]: https://snyk.io/test/github/adonisjs/validator?targetFile=package.json "synk"
[license-url]: LICENSE.md
[license-image]: https://img.shields.io/github/license/adonisjs/validator?style=for-the-badge

0 comments on commit fe08b54

Please sign in to comment.