Skip to content

Instantly share code, notes, and snippets.

@mkutz
Last active March 23, 2023 18:46
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save mkutz/675b6ae137e0a0d9b6cb2b3803c940ba to your computer and use it in GitHub Desktop.
Save mkutz/675b6ae137e0a0d9b6cb2b3803c940ba to your computer and use it in GitHub Desktop.
A template for better README.md

{What is the name of this?}

{WHY whould the reader want to read on? WHAT can this do? What are its limits?}

Usage

{What is the MINIMUM I need to do to use this?}

codeblocks.areGreat = true
but.peopleWill(justCopyThem) // so use code comments to explain

Configuration

{WHY would I use the configuration? HOW do I do it?}

{Special use case A}

{In what case do I want to do this?}

{What do I need to do?}

Further Infomation

{What else do I want to look at? Why?}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment