doc: additional README context

[bradh]

Motivation and Context

420 identified that we might need a bit more context for getter and setter methods.

Description

Add extra details to README.md.

How Has This Been Tested?

N/A

Screenshots (if appropriate):

Types of changes

• [X] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• [X] My code follows the code style of this project.
• [X] My change requires a change to the documentation.
• [X] I have updated the documentation accordingly.
• [X] I have read the CONTRIBUTING document.
• [ ] I have added tests to cover my changes.
• [X] All new and existing tests passed.

[codecov-commenter]

Codecov Report

Merging #422 (2817dd5) into 2.x (bf0c3c3) will increase coverage by 1.51%. The diff coverage is n/a.

@@             Coverage Diff              @@
##                2.x     #422      +/-   ##
============================================
+ Coverage     91.03%   92.55%   +1.51%     
- Complexity     5610     5662      +52     
============================================
  Files           610      610              
  Lines         14571    14571              
  Branches       1379     1379              
============================================
+ Hits          13265    13486     +221     
+ Misses         1269     1018     -251     
- Partials         37       67      +30     

Flag	Coverage Δ
unittests-api	98.67% <ø> (ø)
unittests-api-ffmpeg	31.49% <ø> (+15.64%)	:arrow_up:
unittests-awt	100.00% <ø> (ø)
unittests-core	98.44% <ø> (ø)
unittests-geoid	100.00% <ø> (ø)
unittests-mimd	97.24% <ø> (ø)
unittests-st0601	99.26% <ø> (ø)
unittests-st0602	99.06% <ø> (ø)
unittests-st0805	99.17% <ø> (ø)
unittests-st0806	99.64% <ø> (ø)
unittests-st0808	99.08% <ø> (ø)
unittests-st0809	99.11% <ø> (ø)
unittests-st0903-vmti	98.79% <ø> (ø)
unittests-st0903-vtrack	97.09% <ø> (ø)
unittests-st1108	99.66% <ø> (ø)
unittests-st1206	99.59% <ø> (ø)
unittests-st1301	98.91% <ø> (ø)
unittests-st1403	100.00% <ø> (ø)
unittests-st1601	100.00% <ø> (ø)
unittests-st1602	100.00% <ø> (ø)
unittests-st1603	98.03% <ø> (ø)
unittests-st1909	99.65% <ø> (ø)

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

Impacted Files	Coverage Δ
...src/main/java/org/jmisb/api/video/FfmpegUtils.java	14.89% <0.00%> (+4.25%)	:arrow_up:
...src/main/java/org/jmisb/api/video/VideoOutput.java	47.12% <0.00%> (+47.12%)	:arrow_up:
...g/src/main/java/org/jmisb/api/video/FfmpegLog.java	64.70% <0.00%> (+52.94%)	:arrow_up:
...ain/java/org/jmisb/api/video/OutputStatistics.java	54.54% <0.00%> (+54.54%)	:arrow_up:
...in/java/org/jmisb/api/video/VideoStreamOutput.java	63.90% <0.00%> (+63.90%)	:arrow_up:
.../src/main/java/org/jmisb/api/video/CodecUtils.java	95.83% <0.00%> (+95.83%)	:arrow_up:

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.