Skip to content

@magic gitbadges. outputs a list of badges for a git repository (travis, appveyor, greenkeeper, coveralls, npm)

License

Notifications You must be signed in to change notification settings

magic-modules/git-badges

Repository files navigation

@magic-modules/git-badges

git badges for your @magic project.

html docs / demo

NPM version Linux Build Status Windows Build Status Coverage Status Greenkeeper badge Known Vulnerabilities

install:

npm install --save-exact @magic-modules/git-badges

usage:

// in any component view
const component = {
  View: () => GitBadges({
    // shows npm, travis, coveralls appveyor and greenkeeper badges with this project
    project: 'user/project',

    // optional
    // (use if url to badge for one service is different to project above)
    // every one of this arguments can be false to hide a certain badge
    npm: 'user/project' || false,
    travis: 'user/project' || false,
    coveralls: 'user/project' || false,
    appveyor: 'user/project' || false,
    greenkeeper: 'user/project' || false,

    // optional, master is default value
    branch: 'master',
  }),
}

changelog

0.0.1

first commit

0.0.2

use @magic npm packages instead of github for installs

0.0.3

fix installation typo in readme

0.0.4
  • require node 13.5.0
  • add node badge
  • allow badges not to have a link
0.0.5
  • add margin to top and bottom
  • make image height relative to font-height
0.0.6

make images a bit smaller (1.3em instead of 1.5em) this makes them fit on a line if max-width is 1200px

0.0.7

component: images have a default height in their html tag now. style: image now has height of 23px and margin of 15px 0.

0.0.8

fix: badges are clickable (again)

0.0.9
  • greenkeeper shutting down, removed badge.
  • added license badge
0.0.10

bump required node version to 14.2.0

0.0.11

bump required node version to 14.15.4

0.0.12

update dependencies

0.0.13 - unreleased

...

About

@magic gitbadges. outputs a list of badges for a git repository (travis, appveyor, greenkeeper, coveralls, npm)

Resources

License

Stars

Watchers

Forks

Packages

No packages published