├── .gitattributes ├── .gitignore ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE └── README.md /.gitattributes: -------------------------------------------------------------------------------- 1 | *.md linguist-detectable=true 2 | *.md linguist-documentation=false 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Created by https://www.toptal.com/developers/gitignore/api/osx 3 | # Edit at https://www.toptal.com/developers/gitignore?templates=osx 4 | 5 | ### OSX ### 6 | # General 7 | .DS_Store 8 | .AppleDouble 9 | .LSOverride 10 | 11 | # Icon must end with two \r 12 | Icon 13 | 14 | # Thumbnails 15 | ._* 16 | 17 | # Files that might appear in the root of a volume 18 | .DocumentRevisions-V100 19 | .fseventsd 20 | .Spotlight-V100 21 | .TemporaryItems 22 | .Trashes 23 | .VolumeIcon.icns 24 | .com.apple.timemachine.donotpresent 25 | 26 | # Directories potentially created on remote AFP share 27 | .AppleDB 28 | .AppleDesktop 29 | Network Trash Folder 30 | Temporary Items 31 | .apdisk 32 | 33 | # End of https://www.toptal.com/developers/gitignore/api/osx 34 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | - Demonstrating empathy and kindness toward other people 21 | - Being respectful of differing opinions, viewpoints, and experiences 22 | - Giving and gracefully accepting constructive feedback 23 | - Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | - Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | - The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | - Trolling, insulting or derogatory comments, and personal or political attacks 33 | - Public or private harassment 34 | - Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | - Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | ![](https://img.shields.io/badge/conduct-%40shields.io-blue) or directly to [@calebcartwright](https://github.com/calebcartwright) ![](https://img.shields.io/badge/caleb-%40shields.io-blue) or [@paulmelnikow](https://github.com/paulmelnikow) ![](https://img.shields.io/badge/paul-%40shields.io-blue) 64 | 65 | All complaints will be reviewed and investigated promptly and fairly. 66 | 67 | All community leaders are obligated to respect the privacy and security of the 68 | reporter of any incident. 69 | 70 | ## Enforcement Guidelines 71 | 72 | Community leaders will follow these Community Impact Guidelines in determining 73 | the consequences for any action they deem in violation of this Code of Conduct: 74 | 75 | ### 1. Correction 76 | 77 | **Community Impact**: Use of inappropriate language or other behavior deemed 78 | unprofessional or unwelcome in the community. 79 | 80 | **Consequence**: A private, written warning from community leaders, providing 81 | clarity around the nature of the violation and an explanation of why the 82 | behavior was inappropriate. A public apology may be requested. 83 | 84 | ### 2. Warning 85 | 86 | **Community Impact**: A violation through a single incident or series 87 | of actions. 88 | 89 | **Consequence**: A warning with consequences for continued behavior. No 90 | interaction with the people involved, including unsolicited interaction with 91 | those enforcing the Code of Conduct, for a specified period of time. This 92 | includes avoiding interactions in community spaces as well as external channels 93 | like social media. Violating these terms may lead to a temporary or 94 | permanent ban. 95 | 96 | ### 3. Temporary Ban 97 | 98 | **Community Impact**: A serious violation of community standards, including 99 | sustained inappropriate behavior. 100 | 101 | **Consequence**: A temporary ban from any sort of interaction or public 102 | communication with the community for a specified period of time. No public or 103 | private interaction with the people involved, including unsolicited interaction 104 | with those enforcing the Code of Conduct, is allowed during this period. 105 | Violating these terms may lead to a permanent ban. 106 | 107 | ### 4. Permanent Ban 108 | 109 | **Community Impact**: Demonstrating a pattern of violation of community 110 | standards, including sustained inappropriate behavior, harassment of an 111 | individual, or aggression toward or disparagement of classes of individuals. 112 | 113 | **Consequence**: A permanent ban from any sort of public interaction within 114 | the community. 115 | 116 | ## Attribution 117 | 118 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 119 | version 2.0, available at 120 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 121 | 122 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 123 | enforcement ladder](https://github.com/mozilla/diversity). 124 | 125 | [homepage]: https://www.contributor-covenant.org 126 | 127 | For answers to common questions about this code of conduct, see the FAQ at 128 | https://www.contributor-covenant.org/faq. Translations are available at 129 | https://www.contributor-covenant.org/translations. 130 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to Awesome Badges 2 | 3 | Please note that this project is released with a 4 | [Contributor Code of Conduct][code of conduct]. By participating in this project 5 | you agree to abide by its terms. 6 | 7 | 8 | ## Guidelines for inclusion 9 | 10 | 1. To be included in this list, a project must and relate to status badges. 11 | 2. A link may be helpful to developers and non-developers. 12 | 3. It must be substantive. Blog posts may be included at the maintainers' 13 | discretion, however we're not going to list every blog post about how to 14 | add a badge to your project. 15 | 4. Linked projects need not be related to Shields.io or adopt the 16 | [Shields.io badge specification][] or any other particular standard. 17 | Popular, well-documented alternatives to Shields are specifically 18 | welcomed. 19 | 5. Projects which are of historical interest and not actively maintained may 20 | only be listed in the _graveyard_ section. 21 | 6. As this list matures, we reserve the right to revise these guidelines, 22 | and to add or remove resources at its discretion. 23 | 24 | [code of conduct]: ./CODE_OF_CONDUCT.md 25 | [Shields.io badge specification]: https://github.com/badges/shields/blob/master/spec/SPECIFICATION.md 26 | 27 | 28 | ## Proposing changes 29 | 30 | To propose changes to this list, open a pull request. Sindre Sorhus maintains 31 | [some instructions][instructions] on how to do that. 32 | 33 | [instructions]: https://github.com/sindresorhus/awesome/blob/main/contributing.md#adding-something-to-an-awesome-list 34 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Creative Commons Legal Code 2 | 3 | CC0 1.0 Universal 4 | 5 | CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE 6 | LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN 7 | ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS 8 | INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES 9 | REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS 10 | PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM 11 | THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED 12 | HEREUNDER. 13 | 14 | Statement of Purpose 15 | 16 | The laws of most jurisdictions throughout the world automatically confer 17 | exclusive Copyright and Related Rights (defined below) upon the creator 18 | and subsequent owner(s) (each and all, an "owner") of an original work of 19 | authorship and/or a database (each, a "Work"). 20 | 21 | Certain owners wish to permanently relinquish those rights to a Work for 22 | the purpose of contributing to a commons of creative, cultural and 23 | scientific works ("Commons") that the public can reliably and without fear 24 | of later claims of infringement build upon, modify, incorporate in other 25 | works, reuse and redistribute as freely as possible in any form whatsoever 26 | and for any purposes, including without limitation commercial purposes. 27 | These owners may contribute to the Commons to promote the ideal of a free 28 | culture and the further production of creative, cultural and scientific 29 | works, or to gain reputation or greater distribution for their Work in 30 | part through the use and efforts of others. 31 | 32 | For these and/or other purposes and motivations, and without any 33 | expectation of additional consideration or compensation, the person 34 | associating CC0 with a Work (the "Affirmer"), to the extent that he or she 35 | is an owner of Copyright and Related Rights in the Work, voluntarily 36 | elects to apply CC0 to the Work and publicly distribute the Work under its 37 | terms, with knowledge of his or her Copyright and Related Rights in the 38 | Work and the meaning and intended legal effect of CC0 on those rights. 39 | 40 | 1. Copyright and Related Rights. A Work made available under CC0 may be 41 | protected by copyright and related or neighboring rights ("Copyright and 42 | Related Rights"). Copyright and Related Rights include, but are not 43 | limited to, the following: 44 | 45 | i. the right to reproduce, adapt, distribute, perform, display, 46 | communicate, and translate a Work; 47 | ii. moral rights retained by the original author(s) and/or performer(s); 48 | iii. publicity and privacy rights pertaining to a person's image or 49 | likeness depicted in a Work; 50 | iv. rights protecting against unfair competition in regards to a Work, 51 | subject to the limitations in paragraph 4(a), below; 52 | v. rights protecting the extraction, dissemination, use and reuse of data 53 | in a Work; 54 | vi. database rights (such as those arising under Directive 96/9/EC of the 55 | European Parliament and of the Council of 11 March 1996 on the legal 56 | protection of databases, and under any national implementation 57 | thereof, including any amended or successor version of such 58 | directive); and 59 | vii. other similar, equivalent or corresponding rights throughout the 60 | world based on applicable law or treaty, and any national 61 | implementations thereof. 62 | 63 | 2. Waiver. To the greatest extent permitted by, but not in contravention 64 | of, applicable law, Affirmer hereby overtly, fully, permanently, 65 | irrevocably and unconditionally waives, abandons, and surrenders all of 66 | Affirmer's Copyright and Related Rights and associated claims and causes 67 | of action, whether now known or unknown (including existing as well as 68 | future claims and causes of action), in the Work (i) in all territories 69 | worldwide, (ii) for the maximum duration provided by applicable law or 70 | treaty (including future time extensions), (iii) in any current or future 71 | medium and for any number of copies, and (iv) for any purpose whatsoever, 72 | including without limitation commercial, advertising or promotional 73 | purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each 74 | member of the public at large and to the detriment of Affirmer's heirs and 75 | successors, fully intending that such Waiver shall not be subject to 76 | revocation, rescission, cancellation, termination, or any other legal or 77 | equitable action to disrupt the quiet enjoyment of the Work by the public 78 | as contemplated by Affirmer's express Statement of Purpose. 79 | 80 | 3. Public License Fallback. Should any part of the Waiver for any reason 81 | be judged legally invalid or ineffective under applicable law, then the 82 | Waiver shall be preserved to the maximum extent permitted taking into 83 | account Affirmer's express Statement of Purpose. In addition, to the 84 | extent the Waiver is so judged Affirmer hereby grants to each affected 85 | person a royalty-free, non transferable, non sublicensable, non exclusive, 86 | irrevocable and unconditional license to exercise Affirmer's Copyright and 87 | Related Rights in the Work (i) in all territories worldwide, (ii) for the 88 | maximum duration provided by applicable law or treaty (including future 89 | time extensions), (iii) in any current or future medium and for any number 90 | of copies, and (iv) for any purpose whatsoever, including without 91 | limitation commercial, advertising or promotional purposes (the 92 | "License"). The License shall be deemed effective as of the date CC0 was 93 | applied by Affirmer to the Work. Should any part of the License for any 94 | reason be judged legally invalid or ineffective under applicable law, such 95 | partial invalidity or ineffectiveness shall not invalidate the remainder 96 | of the License, and in such case Affirmer hereby affirms that he or she 97 | will not (i) exercise any of his or her remaining Copyright and Related 98 | Rights in the Work or (ii) assert any associated claims and causes of 99 | action with respect to the Work, in either case contrary to Affirmer's 100 | express Statement of Purpose. 101 | 102 | 4. Limitations and Disclaimers. 103 | 104 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 105 | surrendered, licensed or otherwise affected by this document. 106 | b. Affirmer offers the Work as-is and makes no representations or 107 | warranties of any kind concerning the Work, express, implied, 108 | statutory or otherwise, including without limitation warranties of 109 | title, merchantability, fitness for a particular purpose, non 110 | infringement, or the absence of latent or other defects, accuracy, or 111 | the present or absence of errors, whether or not discoverable, all to 112 | the greatest extent permissible under applicable law. 113 | c. Affirmer disclaims responsibility for clearing rights of other persons 114 | that may apply to the Work or any use thereof, including without 115 | limitation any person's Copyright and Related Rights in the Work. 116 | Further, Affirmer disclaims responsibility for obtaining any necessary 117 | consents, permissions or other rights required for any use of the 118 | Work. 119 | d. Affirmer understands and acknowledges that Creative Commons is not a 120 | party to this document and has no duty or obligation with respect to 121 | this CC0 or use of the Work. 122 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Awesome Badges 2 | 3 | [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) 4 | 5 | A curated collection of awesome things related to status badges. 6 | 7 | _While this list is maintained by Paul Melnikow from the Shields core team, it 8 | includes Shields-related and non-Shields-related resources._ 9 | 10 | ### Dynamic badge services 11 | 12 | - [Shields.io](https://shields.io/) – Original home of the badges, 13 | launched in 2014. 14 | - [Badgen.net](https://badgen.net/) – Fast badge generating service launched 15 | in 2018. 16 | - [NodeICO](https://nodei.co/) – Large-format status badges for Node.js 17 | projects – which were once very popular! 18 | - [PlayBadges](https://playbadges.pavi2410.me) – Show off your Play Store™ app's downloads and ratings in your repo 19 | 20 | ### Badge tools 21 | 22 | - [Badgie](https://badgie.me/) – Scans the contents of your repository and 23 | adds badges based on what it finds. 24 | - [Badges](https://github.com/bevry/badges) – Node.js/Deno/Browser npm package for rendering the HTML of various badges 25 | - [Projectz](https://github.com/bevry/projectz) – Render Badges into your README based on your package.json configuration 26 | - [shields.io Raycast extension](https://www.raycast.com/litomore/badges) – A more convenient UI for creating shields.io badges 27 | 28 | ### Raster badges 29 | 30 | > SVG badges are encouraged because they render better on Retina displays and 31 | > scale up beautifully. However in a few environments, such as Slack and HTML 32 | > email, SVG images won't render, so PNG badges are preferred. Shields offers 33 | > raster badges through its raster server, `raster.shields.io`. 34 | 35 | - [svg-to-image-proxy](https://github.com/badges/svg-to-image-proxy) – 36 | Rasterizing proxy based on Node and Puppeteer which can be hosted on Vercel. 37 | (Since 2019 this code has been used to run `raster.shields.io`, however it's 38 | about to be deprecated in favor of [squint](https://github.com/badges/squint/).) 39 | - [squint](https://github.com/badges/squint/) – Rasterizing proxy based on 40 | Rust and [libcairo](https://www.cairographics.org/). 41 | 42 | ### Static badges 43 | 44 | - [For The Badge](https://forthebadge.com/) – Provides static badges 45 | using a flat and boxy badge design which has become a classic. (This badge 46 | format is available as `?style=for-the-badge` on Shields.io.) 47 | 48 | ### Static badge collections 49 | 50 | - [Badges 4 README.md Profile](https://github.com/alexandresanlim/Badges4-README.md-Profile) – Catalog of Shields.io Badges for readme profiles 51 | - [Project Types](https://project-types.github.io/) – Static badges for 52 | four types of open-source project, as classified in Nadia Eghbal's 53 | _Working in Public_. 54 | - [Simple Badges](https://github.com/developStorm/simple-badges) – Catalog of Shields.io Badges with Simple Icons 55 | 56 | ### Dynamic data providers 57 | 58 | > Dynamic data providers are third parties who publish data APIs which can be 59 | > used to back one of the dynamic badge services: 60 | > 61 | > - [Shields' Endpoint badge](https://shields.io/endpoint) 62 | > - [Badgen's https badge](https://badgen.net/https) 63 | > - [Badgen's RunKit endpoint badge](https://badgen.net/runkit) 64 | 65 | - [Cell Shield](https://cellshield.info) – a service that allows backing a shields.io badge with a cell from a public Google Spreadsheet. 66 | - [TYPO3 Badges](https://typo3-badges.dev) – API that provides 67 | JSON endpoints to render badges of [TYPO3 CMS extensions](https://extensions.typo3.org/) 68 | via Shields or Badgen. 69 | - [Dynamic Badge Formatter](https://github.com/DenverCoder1/dynamic-badge-formatter) – Allows users to apply formatters for metrics, versions, dates, and more to dynamic shields.io badges to make them look consistent. 70 | 71 | ### Badge-rendering software 72 | 73 | - [badge-maker](https://github.com/badges/shields/tree/master/badge-maker) 74 | – JavaScript; supports plastic, flat, flat-square, for-the-badge, and 75 | social styles. Powers Shields.io. 76 | - [badgen](https://github.com/badgen/badgen) – TypeScript; supports classic 77 | and flat. Powers Badgen. 78 | - [gradient-badge](https://github.com/bokub/gradient-badge) – JavaScript; 79 | generates gradient badges in classic and flat. 80 | - [poser](https://github.com/badges/poser) – PHP. 81 | - [pybadges](https://github.com/google/pybadges) – Python. 82 | - [browser-support-badge](https://github.com/hustcc/browser-support-badge) – 83 | JavaScript; generates browser version compatibility badges. 84 | - [badge4j](https://github.com/silentsoft/badge4j) – Java. 85 | 86 | ### Icons 87 | 88 | - [Simple Icons](https://simpleicons.org/) – Home of the bulk of the 89 | icons used by both Shields and Badgen. 90 | - [Custom Icon Badges](https://github.com/DenverCoder1/custom-icon-badges) – Allows users to more easily use Octicons and their own icons and logos on shields.io badges. 91 | - [Simple Badges](https://badges.pages.dev/) – Website for finding and previewing Simple Icons on shields.io badges. 92 | 93 | ### Academic articles 94 | 95 | - [Badges on npm packages](https://cmustrudel.github.io/projects/badges/) 96 | – Data-driven assessment based on signaling theory applied to how 97 | badges are used in npm. 98 | [Published in ICSE 2018](https://cmustrudel.github.io/papers/icse18badges.pdf). 99 | - [On the Usage of Badges in Open Source Packages on GitHub](http://ceur-ws.org/Vol-2605/9.pdf) 100 | – Data-driven study of how status badges are used in Cargo and Packagist 101 | projects. 102 | 103 | ### Historical articles 104 | 105 | - [An Open Source Rage Diamond](https://olivierlacan.com/posts/an-open-source-rage-diamond/) 106 | _(Jun. 5, 2014)_ – An article about the motivation for the Shields 107 | project by one of its creators. 108 | - [Shields badge specification](https://github.com/badges/shields/blob/master/spec/SPECIFICATION.md) 109 | – Visual design specification for Shields. 110 | 111 | ### Talks 112 | 113 | - [Shields.io by Nicco Kunzmann](https://www.youtube.com/watch?v=abBdk8bSPKU) – 114 | A talk given by Nicco Kunzmann for I Love Free Software Day in Berlin, 115 | Feb. 14, 2019. 116 | - [Cool badges for your project by Marcin Mielnicki](https://raw.githubusercontent.com/hacktoberfest-poznan/presentations/master/2018/Cool-badges-for-your-project.pdf) 117 | ([photos](https://www.facebook.com/media/set/?vanity=hacktoberfest&set=a.258422348195183)) 118 | – A talk given by Shields core team member Marcin Mielnicki for 119 | Hacktoberfest Poznań 2018. 120 | 121 | ### Hosting your own badge service 122 | 123 | - [Shields self-hosting](https://github.com/badges/shields/blob/master/doc/self-hosting.md) 124 | – Host your own copy of Shields to Heroku, Vercel, using Docker, or on a Node server. 125 | - [Badgen self-hosting](https://github.com/badgen/badgen.net/#environments) – 126 | Host your own copy of Badgen on Vercel. 127 | 128 | ### Achievement badges 129 | 130 | - [Open Badges](https://openbadges.org/) – A specification for 131 | verifiable digital badges. 132 | - [Badgr](https://www.badgr.org/) – A service for creating verifiable 133 | achievement badges, based on the Open Badges specification. 134 | --------------------------------------------------------------------------------