chore: format README documentation

[tushar-Rathore023]

What changed

Minor formatting improvements to README documentation for readability.

Why

Improves consistency and clarity of documentation.

Testing

• cargo fmt

[pepijnve]

While documentation improvements are of course much appreciated, I'm not sure if just changing some whitespace is useful. This doesn't really change the rendered version of the documentation in any way, so the argument that this improves clarity of documentation doesn't really hold.

Additionally there's already an automated task in place to check that the documentation is formatted as desired which is now failing in this MR. If the documentation layout rules/checks need to be updated in order to improve things then that changing those and automatically applying them would be a more useful contribution.

[tushar-Rathore023]

While documentation improvements are of course much appreciated, I'm not sure if just changing some whitespace is useful. This doesn't really change the rendered version of the documentation in any way, so the argument that this improves clarity of documentation doesn't really hold.

Additionally there's already an automated task in place to check that the documentation is formatted as desired which is now failing in this MR. If the documentation layout rules/checks need to be updated in order to improve things then that changing those and automatically applying them would be a more useful contribution.

Thanks for the feedback! I understand the concern. I’ll close this PR and look for a more substantial documentation improvement.

[tushar-Rathore023]

While documentation improvements are of course much appreciated, I'm not sure if just changing some whitespace is useful. This doesn't really change the rendered version of the documentation in any way, so the argument that this improves clarity of documentation doesn't really hold.

Additionally there's already an automated task in place to check that the documentation is formatted as desired which is now failing in this MR. If the documentation layout rules/checks need to be updated in order to improve things then that changing those and automatically applying them would be a more useful contribution.