search

TheShiveshNetwork / readmekraft

Craft Perfect GitHub Markdown Files with AI
https://readmekraft.vercel.app
GNU General Public License v2.0
21 stars 5 forks source link

FIXES #8: Standardize README.md #9

Closed Code-Hacker26 closed 2 months ago

Code-Hacker26 commented 2 months ago

Issue #8 addresses the need to standardize and enhance the README.md file. The update includes a structured Table of Contents for easy navigation, clear Installation Instructions with prerequisites, and updated Usage Examples. Badges for forks, stars, issues, and license were added for better project insights. Typographical errors were corrected, and all links were verified. These changes ensure a more professional, user-friendly, and informative README.

vercel[bot] commented 2 months ago

@Code-Hacker26 is attempting to deploy a commit to the theshiveshnetwork's projects Team on Vercel.

A member of the Team first needs to authorize it.

TheShiveshNetwork commented 2 months ago

Hey @Code-Hacker26 just an early comment. I saw that you were confused somewhere so just referring here. You can't render images in markdown like this. One way is that you use the editor on github to write the readme. Just take a screenshot and drag and drop to the location you want.

Code-Hacker26 commented 2 months ago

@TheShiveshNetwork I updated the URL link with the Permalink ,plz check if this is feasible solution ?

TheShiveshNetwork commented 2 months ago

I don't think it's working. image

TheShiveshNetwork commented 2 months ago

@Code-Hacker26 It is almost good to go. Can I take it up from here if you don't mind?

Code-Hacker26 commented 2 months ago

@TheShiveshNetwork ya sure,