Skip to content

Commit fb6cf76

Browse files
authored
Update README.md
Improved readability of the README file
1 parent 640e091 commit fb6cf76

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,31 +33,32 @@ The following PHP JSON Patch libraries are included in the benchmark:
3333
The benchmarks were executed on the following system:
3434

3535
- **PHP Version:** 8.2.2-nts
36-
- **Operating System:** Windows 10 Porfessional
36+
- **Operating System:** Windows 10 Professional
3737
- **Memory:** 32GB RAM (4 x 8 GB) 3600 MT/s C18
3838
- **Processor:** Ryzen 7 3700x
3939

4040

4141
## RFC 6902 Compliance Test Results
4242

43-
The compliance test strictly checks if the output json of each library is consistent with the RFC and if the library performs atomic operations. \
44-
Many libraries implicitly converts objects into arrays and while this make the compliace test fail it is still fine if you just have to consume the document in PHP.
43+
The compliance test strictly checks if the output json of each library is consistent with the RFC and if the library performs atomic operations.
4544

4645
| Library | Tests |
4746
|-----------------------------|---------------------------------------------------------------|
4847
| blancks/fast-jsonpatch-php | ![#008000](https://placehold.co/15x15/008000/008000.png) PASS |
48+
| remorhaz/php-json-patch | ![#008000](https://placehold.co/15x15/008000/008000.png) PASS |
4949
| mikemccabe/json-patch-php | ![#990000](https://placehold.co/15x15/990000/990000.png) FAIL |
5050
| php-jsonpatch/php-jsonpatch | ![#990000](https://placehold.co/15x15/990000/990000.png) FAIL |
5151
| xp-forge/json-patch | ![#990000](https://placehold.co/15x15/990000/990000.png) FAIL |
5252
| gamringer/php-json-patch | ![#990000](https://placehold.co/15x15/990000/990000.png) FAIL |
5353
| swaggest/json-diff | ![#990000](https://placehold.co/15x15/990000/990000.png) FAIL |
54-
| remorhaz/php-json-patch | ![#008000](https://placehold.co/15x15/008000/008000.png) PASS |
5554

56-
> **Note:** Libraries that fails this test will be benchmarked as well if no error occurs
55+
> mikemccabe and xp-forge libraries implicitly converts objects into arrays and while this make the compliace test fail it is still fine if you only have to consume the document in PHP. The other ones that failed the compliance test are not reliable for a real-world use
56+
57+
> Libraries that fails this test will be benchmarked as well if no error occurs
5758
5859
## Benchmark Results
5960

60-
The following table shows the average time each library took to apply a patch with 1000 operations to a target document as summary of the performance. \
61+
The following table shows the average time each library took to apply a patch with 1000 operations to a target document as summary of the performance.
6162
The actual benchmark data is available [here](https://docs.google.com/spreadsheets/d/1ZTDWh1k-zzhYHqZB3JMD2WRV0bPRIWUMRbLiMJhMLHk/edit?usp=sharing).
6263

6364
| Library | Microseconds |
@@ -70,8 +71,9 @@ The actual benchmark data is available [here](https://docs.google.com/spreadshee
7071
| php-jsonpatch/php-jsonpatch | 10970 |
7172
| remorhaz/php-json-patch | N/A (needs many hours to complete) |
7273

73-
> **Note:** These results are indicative and may vary depending on the specific use case and system environment.
74+
> Unfortunately remorhaz skyrocket out of the chart just with 20 operations patch. It is in the range of O(2^n) if not worse.
7475
76+
> These results are indicative and may vary depending on the specific use case and system environment.
7577
7678
## How to Run the Benchmarks
7779

@@ -136,4 +138,4 @@ Special thanks to the authors of the JSON Patch libraries tested in this benchma
136138

137139
## License
138140

139-
This software is licensed under the [MIT License](LICENSE.md).
141+
This software is licensed under the [MIT License](LICENSE.md).

0 commit comments

Comments
 (0)