docs: improve documentation

[atcol]

Some small improvements to documentation. More to come -- want to build better examples first.

[atcol]

BTW, the tests fail on lack of Icon for the test DB -- do you know how long it can take to see the change on a database? I added an Icon and it's not visible in the results...Perhaps PEBKAC, it's late here.

[b3ngg]

Good stuff. The docs definitely need improvements. Also, a quick start in the README would be awesome, I think. And the current example is absolutely garbage…

[atcol]

Ok I'll tweak that.

Any advice on getting the database icon test to work?

[b3ngg]

Test seem to fail because of the doctests. Gonna need to either ignore them or use something like https://docs.rs/tokio-test/0.3.0/tokio_test/fn.block_on.html to make it work with async.

[b3ngg]

BTW, the tests fail on lack of Icon for the test DB -- do you know how long it can take to see the change on a database? I added an Icon and it's not visible in the results...Perhaps PEBKAC, it's late here.

Changes should propagate instantly. Do you have your own test DB duplicated, or are you using the one from .example.env? I can also give you access to the example one so you can make changes there. It might be easier. Just comment on the page, and I will add you.
I'm not sure if I'm understanding your problem correctly.

[atcol]

Good stuff. The docs definitely need improvements. Also, a quick start in the README would be awesome, I think. And the current example is absolutely garbage…

BTW do you mean change the example I added or somewhere else? I don't think there's an example in the README

[b3ngg]

BTW do you mean change the example I added or somewhere else? I don't think there's an example in the README

No, your example is great. I mean the examples/todo directory. It doesn't even actually use the library. xD
I already removed the link from the README when adjusting it after the fork. I also have a PR lined up to delete it because this example is actually the reason why we need Tokio as a dependency and not just as a dev-dependency, thus being the only reason why the crate is not WASM-compatible.