Skip to content

Commit 122c7e7

Browse files
committed
chore: enhance README.md with encryption and error correction extensions examples and links
1 parent 3b79b2a commit 122c7e7

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,11 @@ Encoding `"any byte data"` (13 bytes):
149149

150150
---
151151

152-
## Encryption
152+
## Extensions
153+
154+
There are examples in the jvmTest source of how to extend the encoding with encryption or error correction.
155+
156+
### Encryption
153157

154158
Wrap a cipher as a `PayloadTransform` and pass it to `EncodedFormat`:
155159

@@ -171,11 +175,9 @@ val decoded = secureFormat.decodeFromString(SecretPayload.serializer(), token)
171175
```
172176

173177
See [EncryptionExample](https://github.com/Eignex/kencode/blob/main/src/jvmTest/kotlin/com/eignex/kencode/EncryptionExample.kt)
174-
for a BouncyCastle demo.
175-
176-
---
178+
for the full exapmle using BouncyCastle.
177179

178-
## Error Correction
180+
### Error Correction
179181

180182
Wrap an error-correcting code as a `PayloadTransform` to recover from corrupted bytes:
181183

@@ -194,4 +196,4 @@ val decoded = robustFormat.decodeFromString(SecretPayload.serializer(), token)
194196
```
195197

196198
See [ErrorCorrectionExample](https://github.com/Eignex/kencode/blob/main/src/jvmTest/kotlin/com/eignex/kencode/ErrorCorrectionExample.kt)
197-
for a zxing demo with simulated byte corruption.
199+
for the full example using zxing and simulated byte corruption.

0 commit comments

Comments
 (0)