The definitive collection of badges for rendering
- Install:
npm install --save badges
- Module:
require('badges')
- Install:
npm install --save badges
- Module:
require('badges')
- CDN URL:
//wzrd.in/bundle/[email protected]
- Install:
ender add badges
- Module:
require('badges')
This package is published with the following editions:
badges
aliasesbadges/index.js
which uses Editions to automatically select the correct edition for the consumers environmentbadges/source/index.js
is Source + ESNext + Requirebadges/es2015/index.js
is Babel Compiled + ES2015 + Require
Older environments may need Babel's Polyfill or something similar.
// Listing of the badges to output
const list = [
// Custom Badges
// Instead of using the global badge configuration, here we use an array in the format of [name, config]
['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',
'---',
// Testing Badges
'saucelabsbm',
'saucelabs',
'travisci',
'codeship',
'coveralls',
'waffle',
'---',
// Funding Badges
'sixtydevstips',
'patreon',
'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: 'getbadges',
saucelabsUsername: 'bevry',
saucelabsAuthToken: '123',
codeshipProjectUUID: '123',
codeshipProjectID: '123',
githubSlug: 'bevry/getbadges',
sixtydevstipsID: 'd2dcf439c9759e88f3ccec1cef394c10',
patreonUsername: 'bevry',
gratipayUsername: 'bevry',
flattrCode: '344188/balupton-on-Flattr',
flattrUsername: 'balupton',
flattrURL: 'https://flattr.com/profile/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: 'http://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
const result = require('badges').renderBadges(list, config, options)
// Output the result
console.log(result)
Discover the release history by heading on over to the HISTORY.md
file.
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
These amazing people are maintaining this project:
No sponsors yet! Will you be the first?
These amazing people have contributed code to this project:
Discover how you can contribute by heading on over to the CONTRIBUTING.md
file.
Unless stated otherwise all works are:
- Copyright ยฉ 2015+ Bevry Pty Ltd
and licensed under: