# QRG CLI

[![dependency status](https://deps.rs/repo/github/AntoniosBarotsis/qr-rs/status.svg?path=cli)](https://deps.rs/repo/github/AntoniosBarotsis/qr-rs?path=cli)
[![Crates.io](https://img.shields.io/crates/v/qrg)](https://crates.io/crates/qrg)

> QR Generate!

For more information on the project, take a look at the
[README](https://github.com/AntoniosBarotsis/qr-rs#readme) and
[this website](https://antoniosbarotsis.github.io/qr-rs/).

## Installation

> **Note** Make sure you have 
  [Cargo installed](https://doc.rust-lang.org/cargo/getting-started/installation.html)

Currently, as the crate is not published, you can only install it from source with

```sh
# From source
# cargo install --path cli

cargo install qrg
```

## Usage

You can get the list of available commands as follows:

```
$ qrg -h
Generates QRCodes with a logo overlay.

Usage: qrg.exe [OPTIONS] <CONTENT>

Arguments:
  <CONTENT>  The text the qr code should contain

Options:
  -d, --destination <DESTINATION>  The filename the QR Code should be saved in [default: out.png]
  -s, --size <SIZE>                The size of the QR Code [default: 600]
  -c, --bg-color <BG_COLOR>        The background color of the QR Code (in hex) [default: FFFFFF]
  -l, --logo <LOGO>                The name of the logo to use in the overlay [default: google]
  -h, --help                       Print help
  -V, --version                    Print version
```

I will try to keep this outdated but you should run it for yourself just in case some command
detail has changed.

### Example Usage

Create a QR Code pointing to `github.com` and dump the image to a file called `tmp.png`.

```sh
qrg github.com -d tmp.png
```