[ENG-5282] metrics api docs

[aaxelb]

Purpose

document osf.metrics api and data models

Changes

• add osf/metrics/README.md

QA Notes

Please make verification statements inspired by your code and what your code touches.

• Verify
• Verify

What are the areas of risk?

Any concerns/considerations/questions that development raised?

Documentation

Side Effects

Ticket