Merge pull request #44 from Shashank3736/development

Update skia-canvas v1.0.0

.github/SECURITY.md

@@ -11,6 +11,16 @@ This package versioning work like MAJOR.MINOR.PATCH structure.
 
 All the versions before v2.0.2 works very well but have some very small bugs.
 
+### Versions
+#### v1
+v1 is created for simple captcha creations. It is only capable of supporting simple customisation.
+
+#### v2
+v2 is released with more customisation method and a complete new background coding. It may not be wrong to say that I totally changed the code from v1.
+
+#### v3
+v3 is released and I shifted to skia-canvas, also more deeper level customisation is introduced. The whole thing is recoded in Typescript.
+
 ## Reporting a Vulnerability
 
 To report a bug or typos. Create an issue with all the details you have regarding that bug with steps to reproduce it. If you know the way to solve it then you can make a pull request with the solution.

README.md

@@ -1,6 +1,3 @@
-# IMPORTANT NOTE
-I am not actively working on the project anymore. `v3` have almost all the features I need to make captcha and that's why I decided to stop working on this project from here on. I started this project so that I can create captchas for my discord bots easily. `v3` is still active and working perfectly.
-
 # captcha-canvas
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
@@ -13,7 +10,7 @@ This is an npm package [captcha-canvas](https://npmjs.com/package/captcha-canvas
 
 #### Captcha Image:
 
-![captcha](https://github.com/Shashank3736/captcha-canvas/raw/master/assets/captcha/default.png)
+![captcha](examples/example.png)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FShashank3736%2Fcaptcha-canvas.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FShashank3736%2Fcaptcha-canvas?ref=badge_shield)
 
 ### Features

examples/example.js

@@ -1,5 +1,5 @@
 const fs = require('fs');
-const { CaptchaGenerator } = require('../js-script');
+const { CaptchaGenerator, Captcha } = require('../js-script');
 
 (async () => {
  const captcha = new CaptchaGenerator();
@@ -25,5 +25,16 @@ const { CaptchaGenerator } = require('../js-script');
  fs.writeFileSync('./examples/all.png', await captcha.generate());
  // console text of captcha
  console.log(captcha.text);
+ // example captcha
+ const exmCaptcha = new Captcha(600, 200, 8);
+ exmCaptcha.addDecoy({ total: 20, size: 40 });
+ exmCaptcha.drawCaptcha({ size: 40 });
+ exmCaptcha.addDecoy();
+ exmCaptcha.drawTrace();
+
+ exmCaptcha.async = false;
+ console.log('Example captcha text: ' + exmCaptcha.text);
+
+ fs.writeFileSync('./examples/example.png', exmCaptcha.png);
 })();