update readme

[dougbrn]

update the readme

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.55%. Comparing base (5a74ad5) to head (645c1e1).

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #67   +/-   ##
=======================================
  Coverage   97.55%   97.55%           
=======================================
  Files          16       16           
  Lines         818      818           
=======================================
  Hits          798      798           
  Misses         20       20           

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

[github-actions]

Before [5a74ad5]	After [3132d8a]	Ratio	Benchmark (Parameter)
66.4±3ms	68.1±2ms	1.03	benchmarks.ReassignHalfOfNestedSeries.time_run
257M	260M	1.01	benchmarks.AssignSingleDfToNestedSeries.peakmem_run
32.0±2ms	32.2±2ms	1.01	benchmarks.AssignSingleDfToNestedSeries.time_run
8.96±0.1ms	9.03±0.3ms	1.01	benchmarks.NestedFrameQuery.time_run
86M	86M	1	benchmarks.NestedFrameAddNested.peakmem_run
88.4M	88.4M	1	benchmarks.NestedFrameQuery.peakmem_run
88.4M	88.4M	1	benchmarks.NestedFrameReduce.peakmem_run
5.62±0.06ms	5.60±0.1ms	1	benchmarks.NestedFrameReduce.time_run
9.04±0.2ms	8.94±0.07ms	0.99	benchmarks.NestedFrameAddNested.time_run
278M	273M	0.98	benchmarks.ReassignHalfOfNestedSeries.peakmem_run

Click here to view all benchmarks.

[wilsonbb]

LGTM just some minor suggestions