Consider moving "how to use" section of README

[wzieba]

hi 👋! I've noticed that it's not easy to see how to start using the Gravatar Android SDK:

• the code snippet explaining how to add the SDK is on the bottom of the README
• it's also titled "publishing" which I initially missed (I was interested in using the SDK, not publishing it)
• and, this is minor but still, it's written in Groovy, while I think it'd be a nice thing to add Kotlin Script syntax as well

This is opinionated but, I'd also suggest moving most of the README to the GitHub documentation as I think it has many details regarding implementation, rather than using it, which seems to not be very useful for casual users. I'd encourage getting inspiration from some other popular SDKs

I hope that you'll find this feedback useful, and thanks in advance for considering changes!

[AdamGrzybkowski]

Hi @wzieba,

there's a section Getting Started a the top of the README.md that links to a separate .md file with the full instructions on how to use the SDK.

I don't think the Publishing section was meant to be doing that, so maybe it's worth removing the part about how to add it to the project.

[wzieba]

Ah I see, it's indeed at the top. Thanks! Anyway, I'd still suggest moving most of this readme to some documentation section.