liyatheresa/Thesaurus

Document the project in README.md.

Closed this issue · 0 comments

README files tell other people why your project is useful, what they can do with your project, and how they can use it. Any good project will have a well-documented README file (or links to external documentation).

Let's create a good one for To Do. Make sure to include the following at the very minimum:

  • Overview: Describe your project, purpose, features, tech stack used, etc.
  • Dependencies: List external libraries that this project depends on, and their purpose.
  • Invitation for others to contribute.

Links:

  • Learn about creating a good README from here.
  • Learn about formatting and styling in GitHub from here. (how to highlight, how to include code snippets, images, hyperlinks, tables)

README files are important and will help your project stand out. Take your time to complete this.