Skip to content

Commit 26cda3d

Browse files
alpertunga-bilealpertunga-bile
committed
README file is updated
1 parent 4615b99 commit 26cda3d

File tree

1 file changed

+25
-34
lines changed

1 file changed

+25
-34
lines changed

‎README.md‎

Lines changed: 25 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -12,51 +12,42 @@ C++20 implemantation of [lz-string](https://github.com/pieroxy/lz-string)
1212

1313
## Features
1414

15-
- Includes all compresses and decompresses
15+
- Includes all compress and decompress functions
1616
- No dependencies (tests require GoogleTest and benchmark require Google Benchmark. They are installed automatically.)
1717

1818
## Tests
1919

2020
- Current tests are:
2121

22-
| Test Name | Description |
23-
| :--------: | :-------------------------------------------------- |
24-
| HelloWorld | Classic hello world |
25-
| AllASCII | Including all the ASCII characters |
26-
| JSON | Temp json including all data types except float |
27-
| JSONFloat | Temp json file including floats, objects and arrays |
22+
| Test Name | Description |
23+
| :---------: | :-------------------------------------------------- |
24+
| HelloWorld | Classic hello world |
25+
| AllASCII | Including all the ASCII characters |
26+
| JSON | Temp json including all data types except float |
27+
| JSONFloat | Temp json file including floats, objects and arrays |
28+
| PI | PI number's digits |
29+
| Lorem Ipsum | Default lorem ipsum text |
30+
| Repeated | Including repeated pattern |
31+
| Tattoo | Classic text paragraph to test |
2832

2933
- Can run the tests with `run_tests` script files.
3034

31-
- Compress tests are following these steps:
32-
33-
1. Get the encoded string with original script and convert it to Uint16Array
34-
2. Compress the input string with implementation and calculate uint16_t array
35-
3. Compare the results
36-
37-
- Decompress tests are following these steps:
38-
39-
1. Compress the input string
40-
2. Decompress the compressed string
41-
3. Check equality of the input and the decompressed strings
42-
4335
### Test Results
4436

45-
- Last updated date (dd-MM-yyyy): 10-12-2024
46-
47-
48-
| Function | HelloWorld | AllASCII | JSON | JSONFloat |
49-
| :------------------: | :--------: | :------: | :---: | :-------: |
50-
| Compress | ✔ | ✔ | ✔ | ✔ |
51-
| CompressUTF16 | ✔ | ✔ | ✔ | ✔ |
52-
| CompressBase64 | ✔ | ✔ | ✔ | ✔ |
53-
| CompressURI | ✔ | ✔ | ✔ | ✔ |
54-
| CompressUint8Array | ✔ | ✔ | ✔ | ✔ |
55-
| Decompress | ✔ | ✔ | ✔ | ✔ |
56-
| DecompressUTF16 | ✔ | ✔ | ✔ | ✔ |
57-
| DecompressBase64 | ✔ | ✔ | ✔ | ✔ |
58-
| DecompressURI | ✔ | ✔ | ✔ | ✔ |
59-
| DecompressUint8Array | ✔ | ✔ | ✔ | ✔ |
37+
- Last updated date (dd-MM-yyyy): 13-12-2024
38+
39+
| Function | HelloWorld | AllASCII | JSON | JSONFloat | PI | Lorem Ipsum | Repeated | Tattoo |
40+
| :------------------: | :--------: | :------: | :--: | :-------: | :-: | :---------: | :------: | :----- |
41+
| Compress | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
42+
| CompressUTF16 | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
43+
| CompressBase64 | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
44+
| CompressURI | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
45+
| CompressUint8Array | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
46+
| Decompress | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
47+
| DecompressUTF16 | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
48+
| DecompressBase64 | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
49+
| DecompressURI | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
50+
| DecompressUint8Array | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
6051

6152
## Benchmark
6253

0 commit comments

Comments
 (0)