diff --git a/README.md b/README.md new file mode 100644 index 0000000..82d4bc0 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# Bilingual Invoice Generator + +![Example invoice screenshot](example/invoice_example_screenshot.png) + +[PDF](example/invoice_1_01_02_20.pdf) + +## Build + +### Install dependencies + +```shell +composer install +``` + +### Create config and translation files + +```shell +cp config/parameters.yaml.dist config/parameters.yaml.dist +cp translations/source.yaml.dist translations/source.yaml +cp translations/target.yaml.dist translations/target.yaml +``` + +## Usage + +```shell +# Generate file name +./generate 123 ./ + +# Use exact file name +./generate 123 ./invoice.pdf + +# Set issue date +./generate 123 ./ --issue-date 01.01.1970 + +# Get help +./generate --help +``` diff --git a/example/invoice_1_01_02_20.pdf b/example/invoice_1_01_02_20.pdf new file mode 100644 index 0000000..ee1c7e3 Binary files /dev/null and b/example/invoice_1_01_02_20.pdf differ diff --git a/example/invoice_example_screenshot.png b/example/invoice_example_screenshot.png new file mode 100644 index 0000000..e7e173d Binary files /dev/null and b/example/invoice_example_screenshot.png differ