Skip to content

Commit

Permalink
Update README.md and Increase version number
Browse files Browse the repository at this point in the history
  • Loading branch information
ymzEmre committed Feb 12, 2024
1 parent 6872a51 commit 9f9bc91
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 30 deletions.
36 changes: 7 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,15 @@
- [Introduction](#introduction)
- [Installation](#installation)
- [Usage](#usage)
- [1) Pre-defined regex functions](#1-use-with-pre-defined-regex-functions)
- [2) customPattern function](#2-use-with-custompattern-function)
- [3) GeneratorPattern class](#3-use-with-generatorpattern-function)
- [1) Pre-defined Regex Functions](#1-use-with-pre-defined-regex-functions)
- [2) customPattern Function](#2-use-with-custompattern-function)
- [3) GeneratorPattern Class](#3-use-with-generatorpattern-function)
- [Pre-defined Regex Functions](#pre-defined-regex-functions)
- [Contribution](#contribution)
- [License](#mit-license)

## Introduction

This package is still in the beta stage, please use it carefully.

I abbreviated the expression "Form Regular Expression" as "FOGEX" to give the library its name.

A JavaScript library for quickly and easily testing the validity or invalidity of a value.
Expand All @@ -29,12 +27,6 @@ A JavaScript library for quickly and easily testing the validity or invalidity o
npm install fogex
```

or

```
yarn add fogex
```

## Usage

### 1) Use with pre-defined regex functions
Expand All @@ -52,7 +44,7 @@ isEmail('test@test') // false

`isPhoneNumber`

###### Use with parameters
###### Use with parameter

```JavaScript
import { isPhoneNumber } from 'fogex'
Expand All @@ -68,6 +60,8 @@ isPhoneNumber('5555555555', 'US') // true

`isPin `

###### Use with parameter

```JavaScript
import { isPin } from 'fogex'
```
Expand All @@ -91,7 +85,7 @@ isCreditCard('XXXX XXXX XXXX XXXX') // true
isCreditCard('XXXXXXXXXXXXXXXX') // true
```

###### Use with parameters
###### Use with parameter

```JavaScript
isCreditCard('XXXX XXXX XXXX XXXX', 'VISA') // true
Expand Down Expand Up @@ -150,22 +144,6 @@ const isValid = validator.validate(value)
console.log(isValid) // true
```

###### or

```JavaScript
const validator = new GeneratorPattern({
minLength: 6,
maxLength: 12,
lowerCase: true,
upperCase: true,
number: true,
specialCharacter: true,
})

const isValid = validator.validate(value)
console.log(isValid)
```

## Pre-defined Regex Functions

| Tables | Description | Parameter |
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "fogex",
"version": "0.0.23",
"version": "0.0.26",
"description": "A JavaScript library for quickly and easily testing the validity or invalidity of a value.",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down

0 comments on commit 9f9bc91

Please sign in to comment.