Need of a clearer readme || Getting started || Documentation

[AndreiMotinga]

Hi.
Frist of all, thank you for the gem.

I'm trying to implement it in our system, but failing to see how would I start.
Is there a getting started guide or a tutorial, any wiki that would outline gem's interface,

Which methods are available for us to use?
How was it intended to use?

The only thing that comes to mind is opening and reading through the gem, but I suppose there has to be an easier way.

Thank you

[jvitormichels]

has anyone got any documentation? it would be really useful since the gem seens do be everything i need, but i can't figure out how to use it :(