readme-template VS shields

Compare readme-template vs shields and see what are their differences.

shields

Concise, consistent, and legible badges in SVG and raster format (by badges)
Our great sponsors
  • SurveyJS - Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App
  • WorkOS - The modern identity platform for B2B SaaS
  • InfluxDB - Power Real-Time Data Analytics at Scale
readme-template shields
6 130
3,436 22,285
- 1.8%
6.0 9.7
3 days ago 3 days ago
JavaScript
GNU General Public License v3.0 or later Creative Commons Zero v1.0 Universal
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.

readme-template

Posts with mentions or reviews of readme-template. We have used some of these posts to build our list of alternatives and similar projects. The last one was on 2024-01-25.

shields

Posts with mentions or reviews of shields. We have used some of these posts to build our list of alternatives and similar projects. The last one was on 2024-03-24.
  • Personalizando o README do seu projeto
    7 projects | dev.to | 24 Mar 2024
    Veja no site shields.io. Segue as que eu mais uso:
  • Finally! Colorize ChatGPT Output with AImarkdown Script
    2 projects | dev.to | 20 Mar 2024
  • oImprove your README.md profile with these amazing badges πŸš€
    4 projects | dev.to | 6 Feb 2024
    It's only possible because of Shields Project, Simple Icons & beloved all Contributors. We do respect & love our all contributors.
  • How to Make Your Awesome GitHub Profile
    7 projects | dev.to | 7 Jan 2024
  • </code></li> <li><code><style></code></li> <li><code><xmp></code></li> <li><code><iframe></code></li> <li><code><noembed></code></li> <li><code><noframes></code></li> <li><code><script></code></li> <li><code><plaintext></code></li> </ul> <blockquote> <p>πŸ’‘: To learn more, here's the <a href="https://github.github.com/gfm/#html-blocks">GitHub Flavored Markdown Spec</a> related to HTML blocks.</p> </blockquote> <h3> <a name="finding-inspiration" href="#finding-inspiration"> </a> Finding Inspiration </h3> <p>To help you get started, I suggest looking at other awesome GitHub profiles for ideas. You can go to <a href="https://github.com/abhisheknaiidu/awesome-github-profile-readme">awesome-github-profile-readme</a>, where I've found inspiration when making my profile. </p> <p>Since the profiles are open-source, you can use some of the good ideas for your awesome profile!</p> <p>You can also check out <a href="https://github.com/kshyun28">my profile</a> for some ideas. πŸ˜‰</p> <h3> <a name="adding-badges" href="#adding-badges"> </a> Adding Badges </h3> <p>For adding badges to your profile, you can check out <a href="https://github.com/Ileriayo/markdown-badges">markdown-badges</a>. The repository has a wide selection to choose from, ranging from programming languages to streaming platforms like Netflix.</p> <p>If you can't find what you're looking for or want to create custom badges, you can go to <a href="https://shields.io/">shields.io</a>, which is what <a href="https://github.com/Ileriayo/markdown-badges">markdown-badges</a> use. </p> <p>Here's an example where I used <a href="https://github.com/Ileriayo/markdown-badges">markdown-badges</a> on my profile.<br> <a href="https://res.cloudinary.com/practicaldev/image/fetch/s--rlrJWZvX--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_800/https://res.cloudinary.com/dlieqpdfd/image/upload/v1704616185/GitHub%2520Profile/badges-example_t6jyr6.png" class="article-body-image-wrapper"><img src="https://res.cloudinary.com/practicaldev/image/fetch/s--rlrJWZvX--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_800/https://res.cloudinary.com/dlieqpdfd/image/upload/v1704616185/GitHub%2520Profile/badges-example_t6jyr6.png" alt="Markdown badges example" loading="lazy" width="800" height="127"></a></p> <h3> <a name="adding-icons" href="#adding-icons"> </a> Adding Icons </h3> <p>For adding a <code>skills</code> or <code>tech stack</code> section to your profile, I recommend using <a href="https://github.com/tandpfun/skill-icons">skill-icons</a> which provide beautiful icons.</p> <p>If your icon is not supported, you can go to <a href="https://simpleicons.org/">simpleicons</a>, which has over 2900 SVG icons for popular brands.</p> <p>Here's an example where I used <a href="https://github.com/tandpfun/skill-icons">skill-icons</a> for my profile's tech stack section. <br> <a href="https://res.cloudinary.com/practicaldev/image/fetch/s--QcxDGziL--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_800/https://res.cloudinary.com/dlieqpdfd/image/upload/v1704616185/GitHub%2520Profile/icons-example_nyo1sn.png" class="article-body-image-wrapper"><img src="https://res.cloudinary.com/practicaldev/image/fetch/s--QcxDGziL--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_800/https://res.cloudinary.com/dlieqpdfd/image/upload/v1704616185/GitHub%2520Profile/icons-example_nyo1sn.png" alt="Icons example" loading="lazy" width="800" height="182"></a></p> <h3> <a name="using-emojis" href="#using-emojis"> </a> Using Emojis </h3> <p>In GitHub Flavored Markdown, you can use emojis. To see the full list of supported emojis, you can go to this <a href="https://github.com/ikatyang/emoji-cheat-sheet">emoji-cheat-sheet</a>.</p> <p>If you want to get the list of supported emojis yourself, you can use <a href="https://docs.github.com/en/rest/emojis/emojis#get-emojis">GitHub's Emoji API</a>.</p> <p>Going to <a href="https://api.github.com/emojis">https://api.github.com/emojis</a> on your browser should show a JSON response of all supported emojis.<br> </p> <div class="highlight js-code-highlight"> <pre class="highlight json"><code><span class="p">{</span><span class="w"> </span><span class="nl">"+1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8"</span><span class="p">,</span><span class="w"> </span><span class="nl">"-1"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8"</span><span class="p">,</span><span class="w"> </span><span class="nl">"100"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.githubassets.com/images/icons/emoji/unicode/1f4af.png?v8"</span><span class="p">,</span><span class="w"> </span><span class="nl">"1234"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.githubassets.com/images/icons/emoji/unicode/1f522.png?v8"</span><span class="p">,</span><span class="w"> </span><span class="nl">"1st_place_medal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.githubassets.com/images/icons/emoji/unicode/1f947.png?v8"</span><span class="p">,</span><span class="w"> </span><span class="nl">"2nd_place_medal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.githubassets.com/images/icons/emoji/unicode/1f948.png?v8"</span><span class="p">,</span><span class="w"> </span><span class="nl">"3rd_place_medal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.githubassets.com/images/icons/emoji/unicode/1f949.png?v8"</span><span class="p">,</span><span class="w"> </span><span class="nl">"8ball"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.githubassets.com/images/icons/emoji/unicode/1f3b1.png?v8"</span><span class="p">,</span><span class="w"> </span><span class="err">...</span><span class="w"> </span></code></pre> <div class="highlight__panel js-actions-panel"> <div class="highlight__panel-action js-fullscreen-code-action"> <svg xmlns="http://www.w3.org/2000/svg" width="20px" height="20px" viewbox="0 0 24 24" class="highlight-action crayons-icon highlight-action--fullscreen-on"><title>Enter fullscreen mode Exit fullscreen mode Here's an example where I used emojis for my profile. Adding GitHub Stats For adding cards and stats for your GitHub activity, I recommend using github-readme-stats. You can customize your stat cards with different layouts and themes. Here's an example where I added GitHub stats to my profile. Adding Quotes Adding random quotes to your profile can add a nice touch for visitors. I found github-readme-quotes to be useful for doing just that. Here's what it looks like on my profile. I personally like to add quotes to provide some value to my profile visitors. More Ideas For adding more infographics to your profile, I recommend checking out metrics. This is one of the most starred repositories on GitHub with the github-profile topic, so I couldn't leave this out. Then I found this beautiful resource beautify-github-profile, where you can find more ways to customize your profile. If you're also feeling adventurous, you can explore the github-profile topic here. The repositories are sorted by the number of stars by default. Feel free to explore repositories with the github-profile topic. You might even find ones that aren't used as much but are just what you need. GitHub Profile Achievements While this is not related to customizing your GitHub profile's README.md, I feel the need to include it. If you go to your GitHub profile, you'll notice an Achievements section on the left sidebar. These achievements are fun to collect and can improve your overall GitHub profile. To learn more about what achievements are available and how to get them, check out the list of GitHub profile achievements. Conclusion To recap, we walked through how to create your GitHub profile. Then I showed how to format your profile with GitHub Flavored Markdown and HTML. After that, I shared where you can get inspiration for your own profile. Finally, I gave tips and resources on ways to customize your profile. I hope this can help you in making your awesome GitHub profile. I'd love to see what you can come up with! Thank you for reading and feel free to comment or connect with me here. Resources Managing your GitHub profile README GitHub Basic Writing and Formatting Syntax awesome-github-profile-readme repository markdown-badges repository shields.io skill-icons repository simpleicons.org emoji-cheat-sheet GitHub's Emoji API github-readme-stats repository github-readme-quotes repository metrics repository beautify-github-profile repository repositories with "github-profile" topic github-profile-achievements list
  • Hey Rustaceans! Got a question? Ask here (49/2023)!
    9 projects | /r/rust | 5 Dec 2023
    I just read the above article by the official rust blog. I wanted to ask what is "feature" and "badge" refered to as in this blog? what does it mean? At some places "shields.io badge " is mentioned. Are "badge" and "feature" some rust terminologies? It will be helpful if someone explains me this blog post in fewer words.
  • Hacktoberfest is ON CXXGraph
    3 projects | dev.to | 9 Oct 2023
  • Cool readme on your github profile page with github actions.
    4 projects | dev.to | 30 Sep 2023
    Avoid using an unordered list for this section, as it can become challenging to read. Instead, the key is to categorize and group your skills and certifications, making them more organized and easier to manage. The specific edits required for this section depend on the number of skills, certifications, and other factors. If you have an extensive list, consider utilizing small badges from shields.io where applicable and hide outdated information.
  • Poetry (Packaging) in motion
    2 projects | dev.to | 27 Sep 2023
    I would highly recommend adding (a few!) badges to any repository that you plan on publishing. You can get some great badges from https://shields.io/ along with the info on how to actually generate them. If your repository is public, this should be easy enough. I would say to avoid spamming a ton and having your README looks like a technicolor dreamland. Just having things like package health, SourceRank and dependencies can help inspire faith in a smaller project. Having that can set you apart by showing that your code works! πŸ˜„
  • GitHub profile of the day: Rustin Liu with lots of badges
    2 projects | dev.to | 12 Sep 2023
    Rustin Liu has a static GitHub profile with tons of badges that get updated as you visit the page. Check out the source of the page in the README.md file. Some of the badges are served by Shields.io some, by GitHub itself.
  • Create and Elevate Your GitHub Profile README
    13 projects | dev.to | 13 Aug 2023
    πŸ“• Docs and list of available dynamic badges: https://shields.io/badges/ πŸ™ GitHub Repo: https://github.com/badges/shields

What are some alternatives?

When comparing readme-template and shields you can also consider the following projects:

simple-icons - SVG icons for popular brands

markdown-here - Google Chrome, Firefox, and Thunderbird extension that lets you write email in Markdown and render it before sending.

github-readme-stats - :zap: Dynamically generated stats for your github readmes

mpv-image-viewer - Configuration, scripts and tips for using mpv as an image viewer

react-pdf - πŸ“„ Create PDF files using React

markdown-badges - Badges for your personal developer branding, profile, and projects.

github-profile-readme-generator - πŸš€ Generate GitHub profile README easily with the latest add-ons like visitors count, GitHub stats, etc using minimal UI.

custom-icon-badges - πŸ›‘ Allows users to more easily use Octicons and their own icons and logos on shields.io badges

badges - :flower_playing_cards: Standard and acceptable badges list

awesome-github-profile-readme - 😎 A curated list of awesome GitHub Profile READMEs πŸ“

benchmark - A microbenchmark support library

blog-post-workflow - Show your latest blog posts from any sources or StackOverflow activity or Youtube Videos on your GitHub profile/project readme automatically using the RSS feed