search

BamaCharanChhandogi / READMEasy

READMEasy is a user-friendly web platform that empowers you to generate comprehensive and engaging README files for your software projects.
https://readm-easy.vercel.app
MIT License
12 stars 39 forks source link

Usage Field Generates Random Data When Left Empty #16

Open Utkarshrajmishra opened 1 month ago

Utkarshrajmishra commented 1 month ago

Issue:

When generating a README using the application, if the "Usage" field is left empty, the Gemini API generates random data instead of leaving the field blank. This behavior can lead to confusion for users who did not intend to include this section. Screenshot from 2024-10-02 23-27-23

Screenshot from 2024-10-02 23-33-48

Expected Behavior:

The "Usage" section should be omitted or remain empty if no input is provided by the user.

Suggested Solution:

Modify the behavior of the generator to ensure that when the "Usage" field is left empty, it is either excluded from the README or left as a placeholder (e.g., "No usage instructions provided.").

Utkarshrajmishra commented 1 month ago

Hey @BamaCharanChhandogi , I'm a Hacktoberfest 2024 contributor. Could you please add the hacktoberfest-accepted label to my issue?

Utkarshrajmishra commented 1 month ago

Hey @BamaCharanChhandogi , please review my PR.