Fix readme and examples

[0xpr03]

Rework docs for v5 release.
Also includes cargo fmt and comments for the examples.

Fixes #393, fixes #420
Related to #249

[0xpr03]

We do still talk about that in lib.rs. It's a planned feature but for now completely wrong. As we always emit precise events.

[0xpr03]

Our lib.rs example also differs slightly, in that it's not using channels.

[JohnTitor]

One possible way, to keep them in sync, is to use #![doc = include_str!("../README.md")] (the extended_key_value_attributes feature), which is stabilized in 1.54. I'm okay with or without it.

[JohnTitor]

We don't have to do MSRV check on examples, change the below if conditions:

notify/.github/workflows/main.yml

Lines 45 to 51 in fcaeb0e

	- name: check build example
	if: matrix.version != 'stable'
	run: cargo check -p watcher_kind
	- name: test hot_reload_tide
	if: matrix.version != 'stable'
	run: cargo test -p hot_reload_tide

- if: matrix.version != 'stable' 
+ if: matrix.version == 'nightly'

(I don't remember why we ignore it on stable though...)

I'm going to cleanup CI config in another PR.

[JohnTitor]

Typo on file extension?

[0xpr03]

uh yeah, also thanks for reviewing but just to make sure: It's not finished, just had some time yesterday night

[JohnTitor]

Alright, ping me if it's ready :)

[0xpr03]

Next step would be either a last RC or a release.

[JohnTitor]

Next step would be either a last RC or a release.

I guess a RC release would be preferred as we have some changes since the last release?