README improvments

[dgaylo]

No description provided.

[github-actions]

Benchmark Results

--------------------------------------------------------------------------------- benchmark 'test_bench_Chan': 2 tests --------------------------------------------------------------------------------
Name (time in us)               Min                   Max                Mean             StdDev              Median                IQR            Outliers  OPS (Kops/s)            Rounds  Iterations
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
test_bench_Chan (base)     643.7410 (1.0)      1,106.1320 (1.0)      679.8324 (1.0)      31.7635 (1.0)      675.3145 (1.00)     17.4930 (1.04)      106;101        1.4710 (1.0)        1546           1
test_bench_Chan (head)     647.4530 (1.01)     1,279.9260 (1.16)     680.0133 (1.00)     37.7769 (1.19)     674.5590 (1.0)      16.8380 (1.0)        77;109        1.4706 (1.00)       1546           1
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

------------------------------------------------------------------------- benchmark 'test_bench_WY': 2 tests ------------------------------------------------------------------------
Name (time in ms)           Min               Max              Mean            StdDev            Median               IQR            Outliers       OPS            Rounds  Iterations
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
test_bench_WY (base)     3.3442 (1.0)      4.0706 (1.03)     3.4283 (1.0)      0.0800 (1.15)     3.4066 (1.0)      0.0624 (1.0)         32;23  291.6897 (1.0)         300           1
test_bench_WY (head)     3.3925 (1.01)     3.9439 (1.0)      3.5005 (1.02)     0.0694 (1.0)      3.4848 (1.02)     0.0793 (1.27)         65;7  285.6769 (0.98)        300           1
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

------------------------------------------------------------------------- benchmark 'test_bench_base': 2 tests ------------------------------------------------------------------------
Name (time in ms)             Min               Max              Mean            StdDev            Median               IQR            Outliers       OPS            Rounds  Iterations
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
test_bench_base (base)     1.4286 (1.0)      1.8890 (1.03)     1.4568 (1.0)      0.0297 (1.04)     1.4504 (1.0)      0.0194 (1.0)         61;58  686.4396 (1.0)         697           1
test_bench_base (head)     1.4538 (1.02)     1.8362 (1.0)      1.4856 (1.02)     0.0287 (1.0)      1.4791 (1.02)     0.0210 (1.08)        64;44  673.1433 (0.98)        687           1
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

------------------------------------------------------------------------------- benchmark 'test_bench_no_norm': 2 tests --------------------------------------------------------------------------------
Name (time in us)                  Min                 Max                Mean             StdDev              Median                IQR            Outliers  OPS (Kops/s)            Rounds  Iterations
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
test_bench_no_norm (base)     303.7560 (1.0)      655.7830 (1.09)     326.5171 (1.0)      29.9831 (1.87)     318.7940 (1.0)      18.8725 (1.05)      177;162        3.0626 (1.0)        3281           1
test_bench_no_norm (head)     308.7180 (1.02)     603.9910 (1.0)      326.7517 (1.00)     16.0486 (1.0)      321.1110 (1.01)     17.9185 (1.0)        280;85        3.0604 (1.00)       3239           1
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Legend:
  Outliers: 1 Standard Deviation from Mean; 1.5 IQR (InterQuartile Range) from 1st Quartile and 3rd Quartile.
  OPS: Operations Per Second, computed as 1 / Mean

• base: 5341ea9
• head: e751071