README Cheat Sheet

README Cheat Sheet

Key Points

  • Must include a banner to your README file that describes you; alternatively, you may upload a gif that relates to your line of work.

  • Add some points like:-

  1. Any project you are working on.

  2. What you are currently learning

  3. Any extracurricular activity you do.

  4. Add your Resume.

  5. Add your Mail.

  • Add a Connect with me section in this add all your other accounts where the public can contact you.

  • Must add the skills you have to tell the world what you know and what skills you have like Languages, Tools.

  • If you do Blogging must add your Blog links in the README file.

  • There are many APIs available to make your README file attractive must use them.

Some Helping Tools

  1. Make a new directory in your README file name (.github).

  2. Inside this (.github) directory add a new directory (workflows).

  3. Then inside the workflows make a new file named(blog-post-workflow.yml).

  4. Inside this (blog-post-workflow.yml) file add the content which is provided in the above link.

  5. Add these lines(# Blog posts <!-- BLOG-POST-LIST:START --> <!-- BLOG-POST-LIST:END -->) in your README file html code.

  6. Replace the URL with your blog URL (ex-https://nidhishmalav.hashnode.dev/) in the feed list section.