[][Prettier-Project]

README Badge Generator

This repository/package is a simple CLI utility that takes a given repo owner/repo name combo and either returns the code for my usual badges or adds them directly to the README.

NOTE: The packaged binary of this app is called rbg (README Badge Generator).

Usage

The following snippets demonstrate how to use the app.

To STDOUT

This example demonstrates how to have the badge code sent to STDOUT.

# Generate the badges for a repo owned by 4lch4 and called LT-Commander.
rbg 4lch4 LT-Commander

To a README

This example demonstrates how to have the badge code added to the start of a README file.

# Generate the badges for a repo owned by 4lch4, called LT-Commander, and then
# add the code to the top of the README in the current directory.
rbg 4lch4 LT-Commander -f ./README.md