k9crypt/README.md

A special encryption algorithm created for K9Crypt.

![](https://www.upload.ee/image/18092921/k9crypt-npm-banner.png)

# K9Crypt Algorithm

This is a special encryption algorithm created for K9Crypt.

## Updates

**v1.1.6**

- Due to issues reported in feedback, it has been updated to be usable only as CommonJS.

## Installation

```bash
bun add k9crypt
# npm install k9crypt
# pnpm add k9crypt
# yarn add k9crypt
```

## Usage

```javascript
const k9crypt = require('k9crypt');

async function test() {
  const secretKey = 'VeryLongSecretKey!@#1234567890';
  const encryptor = new k9crypt(secretKey);
  // Or you can use it without providing a secretKey value. A key will be generated by the system.
  // const encryptor = new k9crypt();
  const plaintext = 'Hello, World!';

  try {
    const encrypted = await encryptor.encrypt(plaintext);
    console.log('Encrypted data:', encrypted);

    const decrypted = await encryptor.decrypt(encrypted);
    console.log('Decrypted data:', decrypted);
  } catch (error) {
    console.error('Encryption error:', error);
  }
}

test();
```

## License

This project is licensed under the MIT license.