update docs

[johnfercher]

Description

Related Issue

Checklist

check with "x", ONLY IF APPLIED to your change

• All methods associated with structs has func (<first letter of struct> *struct) method() {} name style.
• Wrote unit tests for new/changed features.
• Followed the unit test when,should naming pattern.
• All mocks created with m := mocks.NewConstructor(t).
• All mocks using m.EXPECT().MethodName() method to mock methods.
• Updated docs/doc.go and docs/*
• Updated 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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.09%. Comparing base (9c854d1) to head (177cb75).
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #484   +/-   ##
=======================================
  Coverage   87.09%   87.09%           
=======================================
  Files          61       61           
  Lines        2330     2330           
=======================================
  Hits         2029     2029           
  Misses        268      268           
  Partials       33       33           

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

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.