badges/awesome-badges
1
0
Fork 0
mirror of https://github.com/badges/awesome-badges.git synced 2025-04-19 05:42:16 +03:00
Code

Publish initial version (#1)

Browse Source
This commit is contained in:
Paul Melnikow 2021-07-09 12:50:14 -04:00 committed by GitHub
parent 7a22312d2b
commit 6d515b93a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 432 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
.gitignore vendored Normal file
View File

@ -0,0 +1,33 @@
# Created by https://www.toptal.com/developers/gitignore/api/osx
# Edit at https://www.toptal.com/developers/gitignore?templates=osx
### OSX ###
# General
.DS_Store
.AppleDouble
.LSOverride
# Icon must end with two \r
Icon
# Thumbnails
._*
# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent
# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk
# End of https://www.toptal.com/developers/gitignore/api/osx

129
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,129 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
- The use of sexualized language or imagery, and sexual attention or
advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
![](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)
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.

33
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,33 @@
# Contributing to Awesome Badges
Please note that this project is released with a
[Contributor Code of Conduct][code of conduct]. By participating in this project
you agree to abide by its terms.
## Guidelines for inclusion
1. To be included in this list, a project must and relate to status badges.
2. A link may be helpful to developers and non-developers.
3. It must be substantive. Blog posts may be included at the maintainers'
discretion, however we're not going to list every blog post about how to
add a badge to your project.
4. Linked projects need not be related to Shields.io or adopt the
[Shields.io badge specification][] or any other particular standard.
Popular, well-documented alternatives to Shields are specifically
welcomed.
5. Projects which are of historical interest and not actively maintained may
only be listed in the _graveyard_ section.
6. As this list matures, we reserve the right to revise these guidelines,
and to add or remove resources at its discretion.
[code of conduct]: ./CODE_OF_CONDUCT.md
[Shields.io badge specification]: https://github.com/badges/shields/blob/master/spec/SPECIFICATION.md
## Proposing changes
To propose changes to this list, open a pull request. Sindre Sorhus maintains
[some instructions][instructions] on how to do that.
[instructions]: https://github.com/sindresorhus/awesome/blob/main/contributing.md#adding-something-to-an-awesome-list

121
LICENSE Normal file
View File

@ -0,0 +1,121 @@
Creative Commons Legal Code
CC0 1.0 Universal
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.
Statement of Purpose
The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").
Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.
For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.
1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:
i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.
2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.
3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.
4. Limitations and Disclaimers.
a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.

116
README.md
View File

@ -1 +1,117 @@
# Awesome Badges
[![Awesome](https://awesome.re/badge.svg)](https://awesome.re)
A curated collection of awesome things related to status badges.
_While this list is maintained by Paul Melnikow from the Shields core team, it
includes Shields-related and non-Shields-related resources._
### Dynamic badge services
- [Shields.io](https://shields.io/) – Original home of the badges,
launched in 2014.
- [Badgen](https://badgen.net/) – Fast badge generating service launched
in 2018.
- [NodeICO](https://nodei.co/) – Large-format status badges for Node.js
projects – which were once very popular!
### Raster badges
> SVG badges are encouraged because they render better on Retina displays and
> scale up beautifully. However in a few environments, such as Slack and HTML
> email, SVG images won't render, so PNG badges are preferred. Shields offers
> raster badges through its raster server, `raster.shields.io`.
- [svg-to-image-proxy](https://github.com/badges/svg-to-image-proxy) –
Rasterizing proxy based on Node and Puppeteer which can be hosted on Vercel.
(Since 2019 this code has been used to run `raster.shields.io`, however it's
about to be deprecated in favor of [squint](https://github.com/badges/squint/).)
- [squint](https://github.com/badges/squint/) – Rasterizing proxy based on
Rust and [libcairo](https://www.cairographics.org/).
### Static badges
- [For The Badge](https://forthebadge.com/) – Provides static badges
using a flat and boxy badge design which has become a classic. (This badge
format is available as `?style=for-the-badge` on Shields.io.)
### Static badge collections
- [Project Types](https://project-types.github.io/) – Static badges for
four types of open-source project, as classified in Nadia Eghbal's
_Working in Public_.
### Dynamic data providers
> Dynamic data providers are third parties who publish data APIs which can be
> used to back one of the dynamic badge services:
>
> - [Shields' Endpoint badge](https://shields.io/endpoint)
> - [Badgen's https badge](https://badgen.net/https)
> - [Badgen's RunKit endpoint badge](https://badgen.net/runkit)
- [Transifex open API endpoints](https://transifex-open-api.herokuapp.com/)
– Data gateway for projects using
[Transifex](https://www.transifex.com/).
### Badge-rendering software
- [badge-maker](https://github.com/badges/shields/tree/master/badge-maker)
– JavaScript; supports plastic, flat, flat-square, for-the-badge, and
social styles. Powers Shields.io.
- [badgen](https://github.com/badgen/badgen) – TypeScript; supports classic
and flat. Powers Badgen.
- [gradient-badge](https://github.com/bokub/gradient-badge) – JavaScript;
generates gradient badges in classic and flat.
- [poser](https://github.com/badges/poser) – PHP.
- [pybadges](https://github.com/google/pybadges) – Python.
- [browser-support-badge](https://github.com/hustcc/browser-support-badge) –
JavaScript; generates browser version compatibility badges.
### Icons
- [Simple Icons](https://simpleicons.org/) – Home of the bulk of the
icons used by both Shields and Badgen.
### Academic articles
- [Badges on npm packages](https://cmustrudel.github.io/projects/badges/)
– Data-driven assessment based on signaling theory applied to how
badges are used in npm.
[Published in ICSE 2018](https://cmustrudel.github.io/papers/icse18badges.pdf).
- [On the Usage of Badges in Open Source Packages on GitHub](http://ceur-ws.org/Vol-2605/9.pdf)
– Data-driven study of how status badges are used in Cargo and Packagist
projects.
### Historical articles
- [An Open Source Rage Diamond](https://olivierlacan.com/posts/an-open-source-rage-diamond/)
_(Jun. 5, 2014)_ – An article about the motivation for the Shields
project by one of its creators.
- [Shields badge specification](https://github.com/badges/shields/blob/master/spec/SPECIFICATION.md)
– Visual design specification for Shields.
### Talks
- [Shields.io by Nicco Kunzmann](https://www.youtube.com/watch?v=abBdk8bSPKU) –
A talk given by Nicco Kunzmann for I Love Free Software Day in Berlin,
Feb. 14, 2019.
- [Cool badges for your project by Marcin Mielnicki](https://raw.githubusercontent.com/hacktoberfest-poznan/presentations/master/2018/Cool-badges-for-your-project.pdf)
([photos](https://www.facebook.com/media/set/?vanity=hacktoberfest&set=a.258422348195183))
– A talk given by Shields core team member Marcin Mielnicki for
Hacktoberfest Poznań 2018.
### Hosting your own badge service
- [Shields self-hosting](https://github.com/badges/shields/blob/master/doc/self-hosting.md)
– Host your own copy of Shields to Heroku, Vercel, using Docker, or on a Node server.
- [Badgen self-hosting](https://github.com/badgen/badgen.net/#environments) –
Host your own copy of Badgen on Vercel.
### Achievement badges
- [Open Badges](https://openbadges.org/) – A specification for
verifiable digital badges.
- [Badgr](https://www.badgr.org/) – A service for creating verifiable
achievement badges, based on the Open Badges specification.