Skip to content

Commit 7fbdc15

Browse files
committed
Update README.md
1 parent b8a8a9b commit 7fbdc15

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ JSSC is an open-source, **lossless string compression algorithm** designed speci
99
1010
JSSC is a complex algorithm featuring multiple internal compression modes tailored for different data structures. During compression, each mode evaluates the input; if its specific conditions are met, it produces a **candidate** string. JSSC then selects the best candidate — the one that achieves the highest compression ratio while passing a mandatory lossless decompression check. This approach results in a slower compression phase but ensures **high compression ratio** and **fast decompression**, as no brute-forcing or validation is required during recovery.
1111

12-
⚠️ **Compatibility Notice:** Compressed strings from v1.x.x are **not compatible** with v2.x.x due to header and encoding changes. JSSC follows Semantic Versioning: successful decompression is guaranteed only if the decompressor version is equal to or newer than the compressor version (within the same major version).
12+
> ⚠️ **Compatibility Notice:** Compressed strings from v1.x.x are **not compatible** with v2.x.x due to header and encoding changes. JSSC follows Semantic Versioning: successful decompression is guaranteed only if the decompressor version is equal to or newer than the compressor version (within the same major version).
1313
1414
## Key Features
1515
- ~**2.5:1 average compression ratio**.
@@ -54,11 +54,13 @@ JSSC depends on:
5454
- [lz-string](https://github.com/pieroxy/lz-string/) by [pieroxy](https://github.com/pieroxy)
5555
- [unicode-emoji-json](https://www.npmjs.com/package/unicode-emoji-json) by [Mu-An Chiou](https://github.com/muan)
5656
- [utf8.js](https://github.com/mathiasbynens/utf8.js) by [Mathias Bynens](https://mathiasbynens.be/)
57+
<br>
5758

5859
JSSC CLI and Format Handling (`.jssc`) depends on:
5960
- [crc-32](https://www.npmjs.com/package/crc-32) by [SheetJS](https://sheetjs.com/)
6061
- [semver](https://semver.npmjs.com/) by [npm](https://www.npmjs.com/)
6162
- [uint8arrays](https://www.npmjs.com/package/uint8arrays) by [Alex Potsides](https://github.com/achingbrain)
63+
<br>
6264

6365
> **Note:** All dependencies (except **JUSTC**) are bundled into the final build.
6466

0 commit comments

Comments
 (0)