Prepare README for v0.5.0 release

[adzialocha]

Closes: #526

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (b032092) 92.19% compared to head (18ac930) 92.19%.
Report is 12 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #532   +/-   ##
=======================================
  Coverage   92.19%   92.19%           
=======================================
  Files         102      102           
  Lines       16108    16108           
=======================================
  Hits        14850    14850           
  Misses       1258     1258           

Files Changed	Coverage Δ
aquadoggo/src/lib.rs	85.71% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[adzialocha]

This looks really amazing to me now! Thank you @sandreae for all of these good ideas for the README.

[adzialocha]

This I stumbled upon, what do you think? It's right at the beginning but directly diverges to other projects, I think that can be a bit confusing (people want to get started with aquadoggo and not with fishy)? Could the section just move down, or at least somehow the links part?

[sandreae]

Yeh, totally agree that it's weird to link out to other resources right away. I had the idea to add a new section near the end of the README titled Resources and here we can list fishy, send-to-node, tutorials etc... Then we don't need to link to them directly in the section you highlighted.

[sandreae]

I also want to add a section showing some GraphQL query examples.

[sandreae]

I'm really happy with it now!! Added a section on the query API and resources, made a few changes in other sections which I think improved clarity.

[sandreae]

Only thing I'm not sure about is that maybe the aquadoggo/README.md should have more stuff in it, or at least a clear link back to the main repo README.

[sandreae]

Aaaaaand actually I recon we need to beef up our doc strings in lib.rs, they still contain something very similar to the old README.

[sandreae]

Aaaaaand actually I recon we need to beef up our doc strings in lib.rs, they still contain something very similar to the old README.

We can include the README there like this: #![doc = include_str!("../README.md")]

[sandreae]

Oh, that's pretty cool, examples in the included README are also run during tests (although it fails right now).

[sandreae]

Oh, that's pretty cool, examples in the included README are also run during tests (although it fails right now).

I had do disable this feature for now cos there is required code setup which we can't do in the README 😅