docs: update readme.md

[darkskygit]

No description provided.

[codecov-commenter]

Codecov Report

Patch and project coverage have no change.

Comparison is base (3152dc0) 77.50% compared to head (807ad9c) 77.50%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main       #7   +/-   ##
=======================================
  Coverage   77.50%   77.50%           
=======================================
  Files          46       46           
  Lines        6756     6756           
=======================================
  Hits         5236     5236           
  Misses       1520     1520           

Flag	Coverage Δ
node-binding-test	22.17% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

Benchmark Results

Linux

group                                     main                                   pr
-----                                     ----                                   --
codec/jwst decode var_int (32 bit)        1.00    318.3±0.29µs        ? ?/sec    1.00    316.8±0.39µs        ? ?/sec
codec/jwst decode var_uint (32 bit)       1.08    306.6±3.98µs        ? ?/sec    1.00    283.8±3.74µs        ? ?/sec
codec/jwst decode var_uint (64 bit)       1.00    306.4±1.87µs        ? ?/sec    1.00    305.1±2.74µs        ? ?/sec
codec/jwst encode var_int (32 bit)        1.01    427.0±4.60µs        ? ?/sec    1.00    424.3±5.35µs        ? ?/sec
codec/jwst encode var_uint (32 bit)       1.00    375.2±0.38µs        ? ?/sec    1.00    375.1±0.15µs        ? ?/sec
codec/jwst encode var_uint (64 bit)       1.00    375.2±0.14µs        ? ?/sec    1.00    376.8±8.59µs        ? ?/sec
codec/lib0 decode var_int (64 bit)        1.00    283.3±3.07µs        ? ?/sec    1.04    293.5±6.85µs        ? ?/sec
codec/lib0 decode var_uint (32 bit)       1.01    245.7±2.81µs        ? ?/sec    1.00    244.3±3.30µs        ? ?/sec
codec/lib0 decode var_uint (64 bit)       1.00    233.7±1.71µs        ? ?/sec    1.01    235.8±1.36µs        ? ?/sec
codec/lib0 encode var_int (64 bit)        1.00    416.5±4.24µs        ? ?/sec    1.05    435.3±4.10µs        ? ?/sec
codec/lib0 encode var_uint (32 bit)       1.00    379.2±4.81µs        ? ?/sec    1.00   380.8±14.20µs        ? ?/sec
codec/lib0 encode var_uint (64 bit)       1.00    303.1±0.60µs        ? ?/sec    1.00    302.9±0.80µs        ? ?/sec
ops/array/jwst/insert                     1.00    395.6±3.72µs        ? ?/sec    1.00    397.0±0.41µs        ? ?/sec
ops/array/jwst/insert range               1.00    530.3±0.52µs        ? ?/sec    1.00    527.8±1.54µs        ? ?/sec
ops/array/jwst/remove                     1.00    276.7±0.25µs        ? ?/sec    1.00    277.4±2.18µs        ? ?/sec
ops/array/yrs/insert                      1.00     89.1±0.52µs        ? ?/sec    1.02     90.7±1.13µs        ? ?/sec
ops/array/yrs/insert range                1.00    113.6±1.16µs        ? ?/sec    1.01    114.4±0.62µs        ? ?/sec
ops/array/yrs/remove                      1.01     96.1±0.30µs        ? ?/sec    1.00     95.1±0.38µs        ? ?/sec
ops/text/jwst/insert                      1.00    148.2±0.70µs        ? ?/sec    1.00    148.2±0.83µs        ? ?/sec
ops/text/jwst/remove                      1.00      3.2±0.00µs        ? ?/sec    1.01      3.2±0.00µs        ? ?/sec
ops/text/yrs/insert                       1.00     42.3±0.03µs        ? ?/sec    1.02     43.0±0.03µs        ? ?/sec
ops/text/yrs/remove                       1.02      2.5±0.02µs        ? ?/sec    1.00      2.4±0.00µs        ? ?/sec
update/parse with jwst/basic.bin          1.01     66.9±0.53µs    81.7 MB/sec    1.00     66.0±0.19µs    82.7 MB/sec
update/parse with jwst/database.bin       1.01     54.3±0.02µs    61.1 MB/sec    1.00     53.7±0.38µs    61.6 MB/sec
update/parse with jwst/large.bin          1.01      4.9±0.03ms    46.3 MB/sec    1.00      4.9±0.02ms    46.6 MB/sec
update/parse with jwst/with-subdoc.bin    1.04      6.3±0.00µs   110.4 MB/sec    1.00      6.1±0.01µs   115.0 MB/sec
update/parse with yrs/basic.bin           1.00     41.3±0.31µs   132.3 MB/sec    1.03     42.5±0.24µs   128.6 MB/sec
update/parse with yrs/database.bin        1.00     33.0±0.03µs   100.5 MB/sec    1.03     33.9±0.11µs    97.6 MB/sec
update/parse with yrs/large.bin           1.00      3.0±0.01ms    75.7 MB/sec    1.01      3.1±0.00ms    74.6 MB/sec
update/parse with yrs/with-subdoc.bin     1.05      5.7±0.03µs   123.1 MB/sec    1.00      5.4±0.00µs   129.7 MB/sec

Windows

group                                     main                                   pr
-----                                     ----                                   --
codec/jwst decode var_int (32 bit)        1.01   438.5±25.01µs        ? ?/sec    1.00   432.9±19.85µs        ? ?/sec
codec/jwst decode var_uint (32 bit)       1.01   383.9±17.55µs        ? ?/sec    1.00   379.4±14.86µs        ? ?/sec
codec/jwst decode var_uint (64 bit)       1.00   388.1±15.79µs        ? ?/sec    1.01   390.7±16.00µs        ? ?/sec
codec/jwst encode var_int (32 bit)        1.00   529.7±36.43µs        ? ?/sec    1.01   535.5±32.51µs        ? ?/sec
codec/jwst encode var_uint (32 bit)       1.01   352.3±19.14µs        ? ?/sec    1.00   348.3±21.80µs        ? ?/sec
codec/jwst encode var_uint (64 bit)       1.04   361.5±21.82µs        ? ?/sec    1.00   346.7±16.77µs        ? ?/sec
codec/lib0 decode var_int (64 bit)        1.05   355.1±12.39µs        ? ?/sec    1.00   339.4±12.91µs        ? ?/sec
codec/lib0 decode var_uint (32 bit)       1.00   309.0±15.87µs        ? ?/sec    1.00   308.0±17.13µs        ? ?/sec
codec/lib0 decode var_uint (64 bit)       1.02   303.9±14.10µs        ? ?/sec    1.00   298.8±14.31µs        ? ?/sec
codec/lib0 encode var_int (64 bit)        1.04   517.2±33.54µs        ? ?/sec    1.00   496.2±26.50µs        ? ?/sec
codec/lib0 encode var_uint (32 bit)       1.09   368.6±22.13µs        ? ?/sec    1.00   336.8±17.05µs        ? ?/sec
codec/lib0 encode var_uint (64 bit)       1.04   361.8±23.16µs        ? ?/sec    1.00   346.9±15.21µs        ? ?/sec
ops/array/jwst/insert                     1.00   483.4±17.44µs        ? ?/sec    1.02   494.8±22.45µs        ? ?/sec
ops/array/jwst/insert range               1.00   648.9±24.14µs        ? ?/sec    1.02   662.1±31.54µs        ? ?/sec
ops/array/jwst/remove                     1.00   311.1±12.01µs        ? ?/sec    1.00   310.1±10.16µs        ? ?/sec
ops/array/yrs/insert                      1.04    133.6±4.78µs        ? ?/sec    1.00    128.7±4.05µs        ? ?/sec
ops/array/yrs/insert range                1.02    183.7±7.46µs        ? ?/sec    1.00    180.4±4.78µs        ? ?/sec
ops/array/yrs/remove                      1.00    189.3±6.79µs        ? ?/sec    1.00    188.4±6.70µs        ? ?/sec
ops/text/jwst/insert                      1.00   229.2±13.90µs        ? ?/sec    1.02   232.7±11.50µs        ? ?/sec
ops/text/jwst/remove                      1.03      5.7±0.19µs        ? ?/sec    1.00      5.5±0.25µs        ? ?/sec
ops/text/yrs/insert                       1.01     59.8±2.05µs        ? ?/sec    1.00     59.1±1.91µs        ? ?/sec
ops/text/yrs/remove                       1.00      5.5±0.27µs        ? ?/sec    1.03      5.7±0.27µs        ? ?/sec
update/parse with jwst/basic.bin          1.00    124.7±5.12µs    43.8 MB/sec    1.03    128.4±4.29µs    42.5 MB/sec
update/parse with jwst/database.bin       1.00     93.8±3.93µs    35.3 MB/sec    1.05     98.3±3.48µs    33.7 MB/sec
update/parse with jwst/large.bin          1.00      6.0±0.30ms    38.1 MB/sec    1.00      6.0±0.19ms    38.2 MB/sec
update/parse with jwst/with-subdoc.bin    1.00     18.5±0.58µs    37.8 MB/sec    1.02     18.8±1.16µs    37.2 MB/sec
update/parse with yrs/basic.bin           1.03     82.6±3.53µs    66.1 MB/sec    1.00     80.5±3.29µs    67.8 MB/sec
update/parse with yrs/database.bin        1.00     62.8±1.80µs    52.8 MB/sec    1.00     62.9±2.42µs    52.7 MB/sec
update/parse with yrs/large.bin           1.00      3.8±0.15ms    59.4 MB/sec    1.07      4.1±0.18ms    55.6 MB/sec
update/parse with yrs/with-subdoc.bin     1.00     13.9±0.42µs    50.5 MB/sec    1.01     14.0±0.36µs    49.9 MB/sec