Getting Started
Last updated
Last updated
mdbadges-cli is an extensive CLI tool to find over 400+ Shields.io badges for your projects without needing to leaving the terminal, featuring multiple commands with different purposes.
To get started, make sure you have at least Node.js 18 installed, then install mdbadges-cli onto your machine by running:
To start using any of the commands, add the mdb prefix, followed by the command name/syntax. For example, to find a Discord badge:
If you need to find what a command does or its syntax while in the terminal, run mdb help to view all commands, aliases, and additional options.
To view aliases, go to the bottom of each command's documentation, where the aliases (if any) will be displayed, separated by a / if there is more than one.
Check out the contributing guidelines before you make a pull request, then make a contribution!
Note that badges which are added to the parent repository (md-badges) are manually added to mdbadges-cli after a couple of days/weeks.
