docs: add screenshots, move encryption to docs/cipher.md, and update readme

This commit is contained in:
2026-09-12 17:47:37 -07:00
parent 652d55cdd7
commit 1436166d82
4 changed files with 18 additions and 10 deletions

10
docs/cipher.md Normal file
View File

@@ -0,0 +1,10 @@
# Encryption
### PLAIN
No encryption. Encodes text directly.
### SPECK32/64 ECB
Block cipher in ECB mode. Each character is encrypted independently — identical plaintext characters produce identical ciphertext. Useful when you want varied-looking output from the same input, but **not secure under real threat models** since patterns in the plaintext leak through.
### SPECK48/96 CTR
Stream cipher mode with a random 24-bit nonce prepended to the output. Identical plaintexts produce different ciphertexts each time. Significantly more secure than ECB. **Rotate your password after roughly every 100 encryptions** to avoid nonce reuse risk within the 24-bit space.

BIN
docs/onscreen.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.6 KiB

BIN
docs/ui.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

View File

@@ -8,17 +8,13 @@
--- ---
<p align="center">
<img src="docs/onscreen.png" alt="inØsight on-screen detection">
</p>
## Encryption <p align="center">
<img src="docs/ui.png" alt="inØsight user interface">
### PLAIN </p>
No encryption. Encodes text directly.
### SPECK32/64 ECB
Block cipher in ECB mode. Each character is encrypted independently — identical plaintext characters produce identical ciphertext. Useful when you want varied-looking output from the same input, but **not secure under real threat models** since patterns in the plaintext leak through.
### SPECK48/96 CTR
Stream cipher mode with a random 24-bit nonce prepended to the output. Identical plaintexts produce different ciphertexts each time. Significantly more secure than ECB. **Rotate your password after roughly every 100 encryptions** to avoid nonce reuse risk within the 24-bit space.
## How ZWUS Works ## How ZWUS Works
@@ -29,6 +25,8 @@ Stream cipher mode with a random 24-bit nonce prepended to the output. Identical
The result is a string of invisible Unicode that carries the full original text. Decoding reverses the mapping: split on the separator, look up each zero-width character to recover the digit, parse the base-N number back to a code point, and reconstruct the string. The result is a string of invisible Unicode that carries the full original text. Decoding reverses the mapping: split on the separator, look up each zero-width character to recover the digit, parse the base-N number back to a code point, and reconstruct the string.
For cipher details, see [docs/cipher.md](docs/cipher.md).
## Use ZWUS in Your Own Projects ## Use ZWUS in Your Own Projects
The encoder/decoder is available as a standalone package for multiple languages: The encoder/decoder is available as a standalone package for multiple languages: