why2-encryption-system.js/README.md

Node.js wrapper for encryption system WHY2 made by ENGO150 in C lang.

# WHY2 Encryption System
<div align=center>
    <img alt="npm download badge" src="https://img.shields.io/npm/dw/why2-encryption-system.js?style=flat-square" />
    <br />
    <a href="https://www.npmjs.com/package/why2-encryption-system.js"><img src="https://nodei.co/npm/why2-encryption-system.js.png?downloads=true&downloadRank=true&stars=true" alt="NPM Banner"></a>
</div>

### This part of project is created completely by [SebestikCZ](https://github.com/SebestikCZ)..[.](https://engo150.github.io/res/rickroll.mp3)

---

### Table of contents

  - [Using in Your projects](#using-in-your-projects)
  - [Example of code](#example-of-code)
  - [Example programs](#example-programs)
  - [External links](#external-links)

## Using in Your projects 

To **encrypt** text, use function `encrypt()` from file `./index.js`.

To **decrypt** text, use function `decrypt()` from file `./index.js`.

~~Jump to [examples](#examples) if you're not sure, how to use.~~

## Example of code

- Encryption:
    ```js
    const { encrypt } = require("why2-encryption-system.js");
    //FIRST VARIANT
    var yourText = await encrypt("Put here text, you want encrypt...", "tzXlZGxkhfYOvRthqokDrmGFyDMylgmeIlrJTpVAwuqrLjABXM"); //The second thing is Your **key**. (The key must be atleast 50 characters long!)

    //SECOND VARIANT
    var yourText = await encrypt("Put here text, you want encrypt..."); //See? You don't have to use Your key. Program will automatically generate one for you.
    ```
**WARNING!** The key from encryption will be printed out along the text value as an object \
**The method needs to be awaited, due to `crypto` randomizer.**
### Exit codes
`-2` - invalid key \
`0` - operation completed successfully \
`-1` - operation failed, description available using error property_

- Decryption:
    ```js
	const { decrypt } = require("why2-encryption-system.js");
	var yourText = decrypt("158.-83.9388.-14.57.8419.113.-98.10576", "tzXlZGxkhfYOvRthqokDrmGFyDMylgmeIlrJTpVAwuqrLjABXM"); //First parameter is Your encrypted text, the second is key you want to use for decryption.
    ```

## Example programs

Uhm... There aren't any examples (for now)... We will maybe create some... Later...

## External links
[npm registry](https://www.npmjs.com/package/why2-encryption-system.js)