A README is commonly the main product a visitor will see when visiting your repository. README data files ordinarily contain info on: Markdown allows for easy linking with your readme.txt as well. Just compose like this to hyperlink a word to a URL: You should use the plugin readme generator https://www.hogwartsishere.com/1767808/