bevry
badges
The definitive collection of badges for rendering
Usage
import { renderBadges } from 'badges'
// Listing of badges to output
const list = [
// Custom Badges
['badge', { image: 'image', alt: 'alt' }],
['badge', { image: 'image', alt: 'alt', url: 'url', title: 'title' }],
[
'shields',
{
left: 'left',
right: 'right',
alt: 'alt',
url: 'url',
title: 'title',
},
],
[
'shields',
{
left: 'left',
right: 'right',
color: 'red',
alt: 'alt',
url: 'url',
title: 'title',
},
],
'---',
// Development Badges
'npmversion',
'npmdownloads',
'daviddm',
'daviddmdev',
'nodeico',
'---',
// Testing Badges
'saucelabsbm',
'saucelabs',
'travisci',
'codeship',
'coveralls',
'codeclimate',
'bithound',
'waffle',
'---',
// Funding Badges
'sixtydevstips',
'patreon',
'opencollective',
'gratipay',
'flattr',
'paypal',
'bitcoin',
'wishlist',
'---',
// Social Badges
'slackinscript',
'slackin',
'gabeacon',
'googleplusone',
'redditsubmit',
'hackernewssubmit',
'facebooklike',
'facebookfollow',
'twittertweet',
'twitterfollow',
'githubfollow',
'githubstar',
'quorafollow',
]
// Configuration for the badges
const config = {
npmPackageName: 'badges',
saucelabsUsername: 'bevry',
saucelabsAuthToken: '123',
codeshipProjectUUID: '123',
codeshipProjectID: '123',
githubSlug: 'bevry/badges',
nodeicoQueryString: { downloads: true, compact: true, height: 2 },
sixtydevstipsID: 'd2dcf439c9759e88f3ccec1cef394c10',
patreonUsername: 'bevry',
opencollectiveUsername: 'bevry',
gratipayUsername: 'bevry',
flattrUsername: 'balupton',
paypalURL: 'https://paypal.me/bevry',
paypalButtonID: 'QB8GQPZAH84N6', // another option instead of paypalURL
paypalUsername: 'bevry', // another option instead of paypalURL
bitcoinURL: 'https://bevry.me/bitcoin',
wishlistURL: 'https://bevry.me/wishlist',
slackinURL: 'https://slack.bevry.me',
gaTrackingID: 'UA-XXXXX-XX',
homepage: 'https://bevry.me',
facebookApplicationID: '123123',
facebookUsername: 'balupton',
twitterUsername: 'bevryme',
githubUsername: 'balupton',
quoraUsername: 'Benjamin-Lupton',
quoraRealname: 'Benjamin Arthur Lupton', // optional, will extract from username
}
// Options for rendering the badges
const options = {
// Filter Category
// When set to a string, will only render badges from the list that of the specified category
// Values can be 'development', 'testing', 'funding', or 'social'
// E.g. to render only funding badges, set to 'funding'
filterCategory: false,
// Filter Scripts
// When true, do not render any badges from the list that are scripts
filterScripts: false,
}
// Render the badges to a string
const result = renderBadges(list, config, options)
// Output the result
console.log(result)If you want to render badges inside your own project's readme files, check out the meta builder projectz which uses this package for badge rendering.
Install
npm
- Install:
npm install --save badges - Import:
import * as pkg from ('badges') - Require:
const pkg = require('badges')
Deno
import * as pkg from 'https://unpkg.com/badges@^4.40.0/edition-deno/index.ts'Skypack
<script type="module">
import * as pkg from '//cdn.skypack.dev/badges@^4.40.0'
</script>unpkg
<script type="module">
import * as pkg from '//unpkg.com/badges@^4.40.0'
</script>jspm
<script type="module">
import * as pkg from '//dev.jspm.io/badges@4.40.0'
</script>Editions
This package is published with the following editions:
badges/source/index.tsis TypeScript source code with Import for modulesbadges/edition-browsers/index.jsis TypeScript compiled against ES2022 for web browsers with Import for modulesbadgesaliasesbadges/edition-es2022/index.jsbadges/edition-es2022/index.jsis TypeScript compiled against ES2022 for Node.js 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modulesbadges/edition-es2022-esm/index.jsis TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modulesbadges/edition-types/index.d.tsis TypeScript compiled Types with Import for modulesbadges/edition-deno/index.tsis TypeScript source code made to be compatible with Deno
History
Discover the release history by heading on over to the HISTORY.md file.
Adding a badge
If you there is a badge that you believe will be common enough for others to benefit from, send in a pull request. Each pull request should:
- Add the badge rendering code to the appropriate category section inside
source/badges.js - If your badge requires a script to run, it should have
badgeScript = true- see other badges for an example - Also remember to export your badge
- Add the badges test data to the test file
source/test.js - Add the badge configuration information to this readme file
README.md - Add the badge name to the
keywordfield ofpackage.json
These changes can be done in multiple commits or the same, it doesn't matter, as we will squash the commits on merge. We will also the changelog entry, so you don't need to do.
Backers
Code
Discover how to contribute via the CONTRIBUTING.md file.
Authors
- Benjamin Lupton — Accelerating collaborative wisdom.
Maintainers
- Benjamin Lupton — Accelerating collaborative wisdom.
Contributors
Finances
Sponsors
- Andrew Nesbitt — Software engineer and researcher
- Balsa — We're Balsa, and we're building tools for builders.
- Codecov — Empower developers with tools to improve code quality and testing.
- Poonacha Medappa
- Rob Morris
- Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
- Syntax — Syntax Podcast
Donors
- Andrew Nesbitt
- Armen Mkrtchian
- Balsa
- Chad
- Codecov
- dr.dimitru
- Elliott Ditman
- entroniq
- GitHub
- Hunter Beast
- Jean-Luc Geering
- Michael Duane Mooring
- Michael Harry Scepaniak
- Mohammed Shah
- Mr. Henry
- Nermal
- Pleo
- Poonacha Medappa
- Rob Morris
- Robert de Forest
- Sentry
- ServieJS
- Skunk Team
- Syntax
- WriterJohnBuck
License
Unless stated otherwise all works are:
- Copyright © Benjamin Lupton
and licensed under: