lbryio / lbrycrd

The blockchain that provides the digital content namespace for the LBRY protocol
https://lbry.com
MIT License
2.58k stars 178 forks source link

Docs: Updated README.md files with TOC and best practices in Markdown #339

Closed adityakaria closed 4 years ago

adityakaria commented 5 years ago

PR Type

What kind of change does this PR introduce?

Motivation

Having a detailed table of contents eases the pain of having to search for information in the given file, and gives the user some helpful jump-links to different parts of the documentation.

Other changes

PR Checklist

adityakaria commented 5 years ago

I notice that TOC has been in other PR's as well, one being for the same file. Just wanted to mark a point of difference that I have added a more detailed TOC.

Apart from that, I have made a couple of other changes that are unique to this PR (as mentioned in the PR description). This is my first contribution to this repository, so any suggestions would be most appreciated. Thanks!