diff --git a/Inter.ttf b/Inter.ttf new file mode 100644 index 0000000000000000000000000000000000000000..be66f25d4a764784a5b194e10000306c4552caac Binary files /dev/null and b/Inter.ttf differ diff --git a/README.md b/README.md index 47fb7ec067f9b9d0b3abc783a1f445b0b334918a..93d10df6fca11baf98cffaf4af1e259e9de81569 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,21 @@ # Invoice -zzz - Generate invoices from the command line. +## Text-based User Interface + ```bash +invoice +``` + +## Command Line Interface + +```bash +# Generate an invoice from information. invoice generate --title "Invoice" \ --id 2 \ --logo ./images/logo.png \ - --from "LaLaLabs, Inc." \ + --from "Dream, Inc." \ --to "Imagine, Inc." \ --date "June 10, 2023" \ --due "June 30, 2023" \ @@ -21,6 +28,25 @@ invoice generate --title "Invoice" \ --notes "For debugging purposes." ``` +Save repeated information with environment variables: + +```bash +export INVOICE_LOGO=/path/to/image.png +export INVOICE_FROM="Dream, Inc." +export INVOICE_TO="Imagine, Inc." +export INVOICE_TAX=0.13 +export INVOICE_RATE=25 +``` + +Generate new invoice: + +```bash +invoice generate \ + --item "Yellow Rubber Duck" --quantity 5 \ + --item "Special Edition Plaid Rubber Duck" --quantity 1 \ + --notes "For debugging purposes." +``` + ## Installation