I like how the project name is formatted as code.
It's missing a TOC though, scrolling through it doesn't give an overview what it contains.
It's missing a TOC though, scrolling through it doesn't give an overview what it contains.
Including table of contents in your README is pretty big overhead if you cannot generate it automatically. This template is meant to be a good starting point for any size of project, so it was a conscious decision to leave table of contents out of it.
If you are doing TOC manually in Confluence you are doing it wrong by the way: Both TOC or links to subpages can be done automatically.
In Jekyll with kramdown you can use {.toc} to get an automatically generated table of contents.
On Github this doesn't exist, so you have to use an external tool like https://ecotrust-canada.github.io/markdown-toc/ (Google "markdown generate TOC" for alternatives)