docs/add-new-methods

[johnfercher]

Description

• Add docs for new methods

Related Issue

Checklist

check with "x", if applied to your change

• All methods associated with structs has func (<first character of struct name> *struct) method() {} name style.
• Wrote unit tests for new/changed features.
• Updated docs/doc.go
• Updated pkg/example_test.go
• Updated README.md
• New public methods/structs/interfaces has comments upside them explaining they responsibilities
• Executed make dod with none issues pointed out by golangci-lint and goreportcard-cli

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (2f3dedc) 100.00% compared to head (1a5b00c) 100.00%.

Additional details and impacted files

@@            Coverage Diff            @@
##              main       #12   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           81        81           
=========================================
  Hits            81        81           

Flag	Coverage Δ
unittests	100.00% <ø> (ø)

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.