review docs

[AnthonySteele]

Summarise the changes this Pull Request makes.

review of the Readme.md document. Needed for a 4.0 release

Please include a reference to a GitHub issue if appropriate.

related to #130

[AnthonySteele]

There is a todo in the docs, but I think that this might be also a code issue.
StatsDServiceCollectionExtensions.AddStatsD does not have a way to specify the new SocketProtocol or an entire StatsDConfiguration object.

Some of the mechanism in there such as ResolveStatsDTransport might also be not needed any more.

[martincostello]

You would use this overload to provide an entire config where the IServiceProvider is available.

An overload that specified the StatsDConfiguration as an input would require separate pre-bootstrap to get values from config as otherwise you're trying to configure it before DI registration is complete. If you really wanted to do that yourself, there's nothing to stop your registering StatsDConfiguration that way with the service collection yourself.

[AnthonySteele]

Indeed, given that overload you can do

        public static IServiceCollection AddStatsD(this IServiceCollection services, StatsDConfiguration configuration)
        {
            return services.AddStatsD((s) => configuration);
        }

But as you pointed out that's not as useful, since you more likely want to populate the StatsDConfiguration with values from config etc, and so create it in a func to call after the DI container is up and working.

it's IMHO worth reviewing that code again, but as a separate thing; it is out of scope of this docs review.

[martincostello]

I'll look at doing a pass on the /// docs later today.