Update README.md

[lizsnyder]

Description

General readability improvements, grammatical fixes, and general conformity to google developer documentation style guide.

Checklist:

• [X ] Followed the style guidelines of this project
• [ X] Changelogs have been updated
• [ X] Unit tests have been added
• [X ] Documentation has been updated

[lizsnyder]

@owais I was a little thrown off by the following paragraph:

"Libraries that produce telemetry data should only depend on opentelemetry-api, and defer the choice of the SDK to the application developer. Applications may depend on opentelemetry-sdk or another package that implements the API."

The use of "should" and "may" are ambiguous here and should be replaced with more direct language. Are we telling users that the libraries only depend on opentelemetry-api? Or is this somehow a suggestion to the user?

Similarly, are we saying applications might depend on the SDK (in this case, when would this happen?), or are we describing something the user's application is allowed to do?

Any help you can give on having more direct language is much appreciated.

[codeboten]

I just noticed that the README doesn't include any information pointing users at the Python contrib repository for additional exporter and instrumentation packages. Do you think it's worth adding a note around this @snyder114?

[hectorhdzg]

LGTM

[lizsnyder]

I just noticed that the README doesn't include any information pointing users at the Python contrib repository for additional exporter and instrumentation packages. Do you think it's worth adding a note around this @snyder114?

@codeboten good call, I added a reference. Do you have any input on my first question above? If not, do you mind merging this PR? No write access

[codeboten]

Thanks for the update, regarding the question i think the language in the specification may be helpful: https://github.com/open-telemetry/opentelemetry-specification/blob/4dc009e899497f4a9f32838d475db5a0acc4157c/specification/library-guidelines.md#expected-usage

[lizsnyder]

@codeboten thanks for the resource. Looks like I found some more docs to work on :) I fixed the text and I think it conveys the correct message. Could you merge when you have a minute?

[lzchen]

I think the purpose of "should only" is to outline that the sdk should not be taken a dependency on by these libraries. I think the rewording "only needs to" loosens this definition.

[lzchen]

The use of "should" and "may" are ambiguous here and should be replaced with more direct language. Are we telling users that the libraries only depend on opentelemetry-api? Or is this somehow a suggestion to the user?

As @codeboten outlined, we are following the specifications for components and behaviour that need to follow "should", "may" and "must" descriptions. They are currently documented to the best of our abilities, but we do not want to change or loosen the definitions.

[lizsnyder]

Okay I understand, thanks. I replaced with the original terminology.

[lizsnyder]

@lzchen after you merged develop it looks like a dependency is missing. Could you help me fix the errors? A little beyond my knowledge.