👨🏼‍🍳 A readme template to use for projects. To give quality and concistency to readme's.

Table of Contents

• template-readme
  • Table of Contents
  • Usage
    • Steps
  • Examples
  • License

Usage

Update description and images/badges in readme.md. Note that project defaults to MIT license. Make sure to update if needed.

Steps

• Add image banner or title
• Update Table of Contents
• Add or remove fitting shields from shields.io
• Remove sections not needed and replace placeholder text

Examples

• sindresorhus/pageres
• awesome-readme – Cureated list of awesome readme's

Related

• template-project

License

MIT © Eivind Mikael Lindbråten