Update documentation

[matejklemen]

Description of Changes

I saw the issue about getting the scaladocs out (#43) and I thought I'd update the docs a bit first. Mostly added single-sentence descriptions and some examples of use.

Might take a look at and update the other packages as well, should I continue in this PR or open a new PR per package?

Includes

• Code changes
• Tests
• Documentation

[inejc]

@matejklemen this is super useful! There's no need for separate PRs 🙂.

[inejc]

And don't worry about failed circleci jobs. This is a result of secrets not being copied to forked projects 👍.

[inejc]

@matejklemen let me know when this is not WIP anymore and I will review it then.

[matejklemen]

@inejc Right, I think this is ready for a review. I didn't manage to finish the docs for all packages, but I think we should try merging this before I continue (or somebody else does) writing docs in another PR.

Mostly in hopes that we keep the documentation style consistent, but also because it's getting a bit tedious to do rebasing 😄

After rebasing, I verified/changed examples so that they are working and also I've added all the required imports to examples as I think that examples that work out of the box are much more useful than saving a few lines by skipping imports.

[inejc]

@matejklemen I completely agree with merging this, I will give it a quick look this week 👍.