inzerosight/ZWUS
1
0
Fork 0
mirror of https://github.com/inzerosight/ZWUS.git synced 2026-09-18 10:55:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release ZWUS-7 as the default encoding

Browse Source
This commit is contained in:
multipleof4
2026-09-16 16:50:55 -07:00
parent adc877d743
commit 5ede2507d7
3 changed files with 23 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
readme.md
View File

@@ -22,20 +22,22 @@ const decoded = zwus.decodeToNumberArray(encoded);
### Base
Higher base = shorter output, but more likely visible in some renderers.
Base 7 ranks printable ASCII so common English characters use one or two digits. Base 6 keeps Unicode code points as numbers. Some platforms strip particular zero-width characters.
```js
zwus.encodeString("hi", 3) // safest
zwus.encodeString("hi", 6) // default, compact
zwus.encodeString("hi", 8) // most compact
zwus.encodeString("hi", 6) // code point encoding
zwus.encodeString("hi", 7) // default, compact for ordinary English text
```
Decode must match the encode base:
```js
zwus.decodeToString(encoded, 6)
zwus.decodeToString(zwus.encodeString("hi", 7), 7)
```
Number arrays use ordinary base digits in every standard. Base 7's frequency ranking applies only to strings. Decoding ignores visible text mixed into a payload.
## 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.