scriptnull / badgeit

[WIP] Hassle-free badges for your READMEs.

[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

github

gitter

bower

travis

circle ci

semaphore ci

coveralls.io

codecov

codeclimate

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:
• flat:
• flat-square:
• social:

Contribute

Please refer Contributing section for guidelines on contributing.