diff --git a/README.md b/README.md index 4e8b4b88c4de466fb6152ac3bf9ed0611af7f744..e8d33da6f081c6eaaf57b640846f035bd6a17fd3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ -# Barcode Creator +# Barcode Creater +The Barcode tool can create different barcodes and save them as a +PNG. Currently supported are: Code128, EAN13, PDF417, QR. + +## Requirements + +Linux + +## Build + +``` +make build +``` + + +## Run + +```bash +Usage: + barcode-creator [OPTIONS] <command> + +different barcodes can be created and saved as png. + +Application Options: + -f, --filename= png filename + +Help Options: + -h, --help Show this help message + +Available commands: + code128 Code128 code + ean EAN code + pdf417 PDF417 code + qr QR code +```