[![Drone][Drone-Badge]][Drone-Project] [![Snyk][Snyk-Badge]][Snyk-Project] [![Prettier][Prettier-Badge]][Prettier-Project] [![NPM License][NPM-License-Badge]][NPM-Package-Page] [![NPM Version][NPM-Version-Badge]][NPM-Package-Page]

[![Discord][Discord-Badge]][Discord-Invite] [![Twitter-Profile][Twitter-Badge]][Twitter-Profile]

# 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` (**R**EADME **B**adge **G**enerator)._

## Usage

The following snippets demonstrate how to use the app.

### To STDOUT

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

```bash
# 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.

```bash
# 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
```

[Drone-Badge]: https://img.shields.io/drone/build/4lch4/README-Badge-Generator?server=https%3A%2F%2Fdrone.4lch4.io&style=flat-square
[Drone-Project]: https://drone.4lch4.io/api/badges/4lch4/README-Badge-Generator/status.svg
[NPM-License-Badge]: https://flat.badgen.net/npm/license/@4lch4/readme-badge-generator
[NPM-Version-Badge]: https://flat.badgen.net/npm/v/@4lch4/readme-badge-generator
[NPM-Package-Page]: https://npmjs.com/package/@4lch4/readme-badge-generator
[Snyk-Badge]: https://img.shields.io/snyk/vulnerabilities/npm/@4lch4/readme-badge-generator?style=flat-square
[Snyk-Project]: https://app.snyk.io/org/alcha/project/75d1a180-e897-4d89-a019-640e5a0a5c7b
[Prettier-Badge]: https://flat.badgen.net/badge/code%20style/prettier/ff69b4
[Prettier-Repo]: https://github.com/prettier/prettier
[Discord-Badge]: https://img.shields.io/discord/325504841541746688?color=7289DA&style=flat-square
[Discord-Invite]: https://discord.gg/W72x4Ks
[Twitter-Badge]: https://flat.badgen.net/twitter/follow/4lch4
[Twitter-Profile]: https://twitter.com/4lch4