diff --git a/README.md b/README.md index 728922c..9e5407b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ A CLI tool for generating build configuration files for PHP projects. +![A flowchart of the Build Configs workflow.](./docs/diagram.png) + ## Supported Projects ### PHP diff --git a/docs/diagram.mmd b/docs/diagram.mmd new file mode 100644 index 0000000..93ccbdc --- /dev/null +++ b/docs/diagram.mmd @@ -0,0 +1,19 @@ +flowchart TD + A[build-configs.yaml] + + subgraph I[Template Files] + Dockerfile.twig + docker-compose.yaml.twig + phpstan.neon.dist.twig + end + + A -->|Include project configuration| B + I -->|Include template files| B + + B(Build Configs) -->|Generate configuration files| J + + subgraph J[Output Files] + Dockerfile + docker-compose.yaml + phpstan.neon.dist + end diff --git a/docs/diagram.png b/docs/diagram.png new file mode 100644 index 0000000..dd22abb Binary files /dev/null and b/docs/diagram.png differ