mirror of
https://github.com/inzerosight/ZWUS.git
synced 2026-04-07 02:02:13 +00:00
47 lines
960 B
Markdown
47 lines
960 B
Markdown
# Zero Width Unicode Standard (ZWUS)
|
|
|
|
Zero Width Unicode Steganography — hide text inside invisible characters.
|
|
|
|
`npm install zwus`
|
|
|
|
## Usage
|
|
|
|
```js
|
|
import zwus from 'zwus';
|
|
|
|
// Encode & decode strings
|
|
const hidden = zwus.encodeString("secret");
|
|
const revealed = zwus.decodeToString(hidden);
|
|
// "secret"
|
|
|
|
// Encode & decode number arrays
|
|
const encoded = zwus.encodeNumberArray([72, 101, 108]);
|
|
const decoded = zwus.decodeToNumberArray(encoded);
|
|
// [72, 101, 108]
|
|
```
|
|
|
|
### Base
|
|
|
|
Higher base = shorter output, but more likely visible in some renderers.
|
|
|
|
```js
|
|
zwus.encodeString("hi", 3) // default, safest
|
|
zwus.encodeString("hi", 6) // compact
|
|
zwus.encodeString("hi", 8) // most compact
|
|
```
|
|
|
|
Decode must match the encode base:
|
|
|
|
```js
|
|
zwus.decodeToString(encoded, 6)
|
|
```
|
|
|
|
## Interop
|
|
|
|
Encoded output is byte-identical to the [Rust crate](https://crates.io/crates/zwus), so you can encode in JS and decode in Rust or vice versa.
|
|
|
|
## License
|
|
|
|
[WTFPL](license)
|
|
|