Skip to content

Instantly share code, notes, and snippets.

@spences10
Created January 14, 2021 09:24
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save spences10/1fde169370815c562c1aa2005657e06b to your computer and use it in GitHub Desktop.
Save spences10/1fde169370815c562c1aa2005657e06b to your computer and use it in GitHub Desktop.
What a good README.md should have:

README.md

  • Description of the problem and solution.
  • Whether the solution focuses on back-end, front-end or if it's full stack.
  • Reasoning behind your technical choices, including architectural.
  • Trade-offs you might have made, anything you left out, or what you might do differently if you were to spend additional time on the project.
  • Link to other code you're particularly proud of.
  • Link to your resume or public profile.
  • Link to to the hosted application where applicable.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment