Add docs for common, practical things one needs in an app

[om26er]

An app that is using ABJ could benefit in terms of debugging connections woos if it was possible to enable/disable debug logs at the library level. Implementing that is of course a simple thing but need to know if, from a security perspective, this is a bad thing etc.

@oberstet thoughts ?

[oberstet]

tbh, my knowledge of Android logging is limited, both rgd best practices, as well as security implications. In general, I guess yes, a library that wants to be a nice citizen should provide some debugging knobs.

From a practical side, and in general, beginning users will need master:

1. general future/async based Java 8 programming
2. serialization/typing related questions (Jackson, classes, POJOs, ..)
3. getting TLS working
4. getting a stable connection (auto-reconnect, heartbeating)

Good docs and examples for above should be the starting point. And then we might add a "when things go wrong" section in the docs, that explains how to track down issues. And this then would involve turning on debug logging or such.

So I am looking at this as in: for us (lib devs), we don't really need it for dev on the library. So it is a user thing. And that is part of a bigger user story: "I want to get started quickly" and "I am running into deeper issues: how do I systematically track down my own issue (supposedly not a library bug)?"