Skip to content

Commit fa63452

Browse files
author
observ33r
committed
docs: update README with JSR score badge, improved example and merged benchmark sections
1 parent b30296b commit fa63452

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[![npm](https://img.shields.io/npm/v/jsoncmp.svg)](https://www.npmjs.com/package/jsoncmp)
22
[![JSR](https://jsr.io/badges/@observ33r/jsoncmp)](https://jsr.io/@observ33r/jsoncmp)
3+
[![JSR Score](https://jsr.io/badges/@observ33r/jsoncmp/score)](https://jsr.io/@observ33r/jsoncmp/score)
34
[![Size](https://badgen.net/bundlephobia/minzip/jsoncmp)](https://bundlephobia.com/package/jsoncmp)
45
[![License](https://img.shields.io/npm/l/jsoncmp.svg)](https://github.com/observ33r/jsoncmp/blob/main/LICENSE)
56
[![Donate](https://img.shields.io/badge/Donate-PayPal-ff69b4.svg)](https://www.paypal.com/donate/?hosted_button_id=PPPN7F3VXXE8W)
@@ -70,8 +71,8 @@ function jsoncmp(target: JSONCmpValue, source: JSONCmpValue): boolean
7071
```ts
7172
import jsoncmp from 'jsoncmp';
7273
73-
const target = JSON.parse('{ "a": 1, "b": [2, 3] }');
74-
const source = JSON.parse('{ "a": 1, "b": [2, 3] }');
74+
const target = JSON.parse('{ "a": 1, "b": ['2', null, false] }');
75+
const source = JSON.parse('{ "a": 1, "b": ['2', null, false] }');
7576
7677
console.log(jsoncmp(target, source)); //true
7778
```
@@ -148,9 +149,9 @@ summary
148149

149150
</details>
150151

151-
## Running Benchmark
152+
---
152153

153-
Benchmark uses [mitata](https://github.com/evanwashere/mitata) for performance testing with big JSON Object to reflect realistic real-world scenario.
154+
Benchmark uses [mitata](https://github.com/evanwashere/mitata) to test performance with [big JSON object](https://github.com/observ33r/jsoncmp/blob/main/benchmark/data.ts) to reflect a realistic real-world scenario.
154155

155156
You can run bechmark with:
156157

0 commit comments

Comments
 (0)