captcha-dot-js/README.md

JavaScript Captcha Production Module

# Languages:
- [English (en)](#javascript-captcha-production-module)

# JavaScript Captcha Production Module

## How to use:

- install:

npm:
```bash
npm i captcha-dot-js
```

- import:

```javascript
const captcha = require('captcha-dot-js');
```

- using:

Using the module is just same as how you call a function, and then as an object you send inputs to it that include the following values, It is mandatory for them to enter the value, All values are boolean type; For example:

```javascript
const captcha = require('captcha-dot-js');

(async () => {
  const myCaptcha = await captcha({
    numbers: true,
    lowercase: true,
    uppercase: true,
    symbols: false,
    difficulty : 1,
    path : './public'
  });
})();
```

| Value           	| Description                                          	|
|-----------------	|------------------------------------------------------	|
| ```numbers```   	| In captcha, have numbers or not                      	|
| ```lowercase``` 	| In captcha, have lowercase alphabet or not           	|
| ```uppercase``` 	| In captcha, have uppercase alphabet or not           	|
| ```symbols```   	| In captcha, have symbols (special characters) or not 	|
| ```difficulty```   	| Determines the hardness value of captcha  	|
| ```path```   	| Specifies the storage folder of captcha images   	|



- Recursive values:

‍‍The recursive values of an object is the same as the example below:

```javascript
{ file_name: 'kvacjoxqjwlveibk.png', captcha: 'pkcsos' }
```

Values:
| Value           	| Description                                        	|
|-----------------	|----------------------------------------------------	|
| ```file_name``` 	| Name of the image file (which captcha is drawn in) 	|
| ```captcha```   	| Captcha value (that is entered in photo)           	|

## Final sentence:

If you have problems or suggestions feel free to open issues; Also this module will be updated from time to time for security reasons, So don't forget to update!