Skip to content

Commit

Permalink
Merge pull request #841 from ftonato/docs/update-project-description
Browse files Browse the repository at this point in the history
docs: update project documentation
  • Loading branch information
ftonato committed May 27, 2022
2 parents b9c0107 + d5b3234 commit 6de1f01
Show file tree
Hide file tree
Showing 4 changed files with 5,536 additions and 14 deletions.
20 changes: 10 additions & 10 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
version: 2
updates:
- package-ecosystem: npm
directory: "/"
schedule:
interval: daily
open-pull-requests-limit: 20
reviewers:
- bvego
assignees:
- bvego
versioning-strategy: increase
- package-ecosystem: npm
directory: '/'
schedule:
interval: daily
open-pull-requests-limit: 20
reviewers:
- ftonato
assignees:
- ftonato
versioning-strategy: increase
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# Nope 🙅

[![CircleCI](https://circleci.com/gh/bvego/nope-validator.svg?style=svg)](https://circleci.com/gh/bvego/nope-validator)
[![CircleCI](https://circleci.com/gh/ftonato/nope-validator.svg?style=svg)](https://circleci.com/gh/ftonato/nope-validator)
[![Fast](https://badgen.now.sh/badge/speed/really%20fast/green)](https://npm.im/nope-validator)
[![Version](https://img.shields.io/npm/v/nope-validator.svg)](https://npm.im/nope-validator)
[![size](https://img.shields.io/bundlephobia/min/nope-validator.svg)](https://bundlephobia.com/result?p=nope-validator)
[![gzip](https://img.shields.io/bundlephobia/minzip/nope-validator.svg)](https://bundlephobia.com/result?p=nope-validator)

> <sup>This project was created by the awesome **[Bruno Vego - @bvego](https://github.com/bvego)**, and is currently maintained by @ftonato and the community.</sup>
A small, simple and fast JS validator. Like, wow thats fast. 🚀

Nope's API is ~~heavily inspired~~ stolen from [Yup](https://github.com/jquense/yup) but Nope attempts to be much smaller and much faster. To achieve this Nope only allows for synchronous data validation which should cover most of the use cases.
Expand All @@ -14,7 +16,7 @@ Nope's API is ~~heavily inspired~~ stolen from [Yup](https://github.com/jquense/

Instead of throwing errors Nope simply returns the error object and if there are no errors it returns undefined.

For more details on what's available in Nope, check out the [documentation](https://github.com/bvego/nope-validator/wiki).
For more details on what's available in Nope, check out the [documentation](https://github.com/ftonato/nope-validator/wiki).

Typescript definitions included. ✨

Expand All @@ -38,7 +40,6 @@ npm install -S nope-validator

or (even), do you wanna to **[try it online](https://replit.com/@ftonato/nope-validator-with-nodeJS)**?


```js
// import the dependency on your app

Expand Down
Loading

0 comments on commit 6de1f01

Please sign in to comment.