While reading the project I noticed that the markdown in the README file could do with some improvements. I have updated the markdown README.md file to come further in line with Markdown formatting guidelines. This will help readability and accessibility, as the file will be more screen-reader friendly.
In particular, I made headings in the "Scripts in this project" consistent and correctly hierarchical.
When starting out, markdownlint showed 128 warnings. At this commit, it shows 11:
Hi folks,
While reading the project I noticed that the markdown in the README file could do with some improvements. I have updated the markdown README.md file to come further in line with Markdown formatting guidelines. This will help readability and accessibility, as the file will be more screen-reader friendly.
In particular, I made headings in the "Scripts in this project" consistent and correctly hierarchical.
When starting out, markdownlint showed 128 warnings. At this commit, it shows 11:
Happy to have a conversation about the changes if necessary :smile_cat: