Write documentation for the Uri package

[eddieajau]

Developer documentation and examples are required for the Uri package.

[javigomez]

Is there any documentation that you think that we can follow as "the perfect example of good documented package"?

[eddieajau]

Sure. Log is what I'd call very thorough:

https://github.com/joomla/joomla-framework/blob/master/vendor/Joomla/Log/README.md

It's what I think we are after for a final product, but it does take a lot of time to write.

But here's what someone did for ArrayHelper:

https://github.com/joomla/joomla-framework/blob/master/vendor/Joomla/Utilities/README.md

It's simple and shows you what it happening. I think that would be fine for this package if your time is limited.

Does that help?

[javigomez]

Indeed, thanks very much.

[drmmr763]

#114

[drmmr763]

Andrew let me know if you think my updates are sufficient or if there's something more you'd like to see in there. New at this, so if there's some key points, let me know and I"ll continue to update.