search

skadogg / personal-tv-guide

Python-based JustWatch scraper
GNU General Public License v3.0
6 stars 7 forks source link

📝 Update readme with more organized structure #102

Closed skadogg closed 6 months ago

skadogg commented 6 months ago

Recently read The Art of Crafting an Effective README for Your GitHub Project. I like the suggested structure for organizing the readme:

Step 3: Add the Necessary Elements As we mentioned earlier, a good README file should include the following elements:

  1. Project Title: A clear and concise title that describes your project.
  2. Introduction: An explanation of what your project is about, what problem it solves, and why it’s useful.
  3. Installation: Step-by-step instructions on how to set up and run your project, including any dependencies or prerequisites.
  4. Usage: Examples and instructions on how to use your project, including any command-line arguments or configuration options.
  5. Contributing: Guidelines for contributing to your project, including how to submit pull requests, report bugs, and request features.
  6. License: Information about the licensing terms of your project, including any restrictions on commercial use or modification.