Skip to content

Instantly share code, notes, and snippets.

@Sasha-hk

Sasha-hk/readme-design-tips.md

Created April 9, 2022 13:40
Show Gist options
  • Save Sasha-hk/ffc16cd72df8c4894ee306d48781d9fa to your computer and use it in GitHub Desktop.
Save Sasha-hk/ffc16cd72df8c4894ee306d48781d9fa to your computer and use it in GitHub Desktop.
Download ZIP
Raw
readme-design-tips.md

Good design tips for your README file

Describe:

  • what is your project about
  • tech stack
  • APIs you use
  • database structure on the chart
  • API reference
  • requirements document
  • project structure
  • base blocks
  • installation guide
  • cuntributing guide
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment