Skip to content

scriptnull/badgeit

Repository files navigation

[WIP] Hassle-free badges for your READMEs.

Install

Download the binary from latest release.

Usage

$ badgeit path-to-source-repo
badge-1
badge-2
badge-n

If path is not specified, current working directory will be default path.

Samples

Here are some samples generated by badgeit, for various kinds of projects.

npm

npm weekly downloads npm monthly downloads npm yearly downloads npm total downloads npm version npm next version npm canary version license badge snyk - known vulnerabilities

github

github all releases github latest release github tag github release github pre release github fork github stars github watchers github open issues github closed issues github open pr github closed pr github contributors github license

gitter

gitter chat room

bower

bower version license badge

travis

travis badge

circle ci

circle badge

semaphore ci

semaphore master badge

coveralls.io

Coveralls

codecov

Codecov

codeclimate

Code Climate Code Climate Code Climate

Formatters

Use -f options to send in the available formatting options.

  • all: all the badges
  • all-json: all the badges in json format
  • min: 7 most favourable badges todo
  • cat: category wise badges todo

If not specified, all is the default formatter

Delimit

Use -d to mention the character sequence between the badges.

$ badgeit -d "\n"
badge-1
badge-2
badge-n

If not specified, blank space will be the default

Style

Use -s to mention the style of the badges generated with shields.io.

$ badgeit -s flat

Available styles are

  • plastic: plastic
  • flat: flat
  • flat-square: flat-square
  • social: social

Contribute

Please refer Contributing section for guidelines on contributing.