Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Harbinger-3 authored Dec 14, 2024
1 parent e93f61e commit 42848be
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ This implementation enhances traditional stream cipher designs, introducing a la

---

# What is `stateVariant`?

The `stateVariant` refers to an optional parameter that allows you to modify the internal cryptographic state of the cipher. It is an array of four integers that adjusts certain internal operations of the algorithm, potentially altering its behavior and the resulting encryption/decryption process.

---

## Supported Environments

**Node.js**: Fully compatible.
Expand Down Expand Up @@ -67,6 +73,7 @@ Ceilidh20(data, {
key: key, // 32-byte key
iv: iv, // 32-byte initialization vector
nonce: nonce // 24-byte nonce
stateVariant: array, // optional custom state variant
isEncrypt: boolean // Flag to indicate encryption or decryption
});
```
Expand Down

0 comments on commit 42848be

Please sign in to comment.