diff --git a/README.md b/README.md index 0faec43bd..28f8f32b3 100644 --- a/README.md +++ b/README.md @@ -146,13 +146,14 @@ pipeline: Melange provides the following default substitutions which can be referenced in the build file pipeline: -| **Substitution** | **Description** | -|--------------------------|---------------------------------------------------| -| `${{package.name}}` | Package name | -| `${{package.version}}` | Package version | -| `${{package.epoch}}` | Package epoch | -| `${{targets.destdir}}` | Directory where targets will be stored | -| `${{targets.subpkgdir}}` | Directory where subpackage targets will be stored | +| **Substitution** | **Description** | +|-----------------------------|---------------------------------------------------| +| `${{package.name}}` | Package name | +| `${{package.version}}` | Package version | +| `${{package.epoch}}` | Package epoch | +| `${{package.full-version}}` | `${{package.version}}-r${{package-epoch}}` | +| `${{targets.destdir}}` | Directory where targets will be stored | +| `${{targets.subpkgdir}}` | Directory where subpackage targets will be stored | An example build file pipeline with substitutions: @@ -162,6 +163,8 @@ pipeline: runs: mkdir ${{targets.destdir}}/var/lib/${{package.name}}/tmp ``` +[More detailed documentation](./docs/) + ## Usage with apko To use a melange built apk in apko, either upload it to a package repository or use a "local" repository. Using a local repository allows a melange build and apko build to run in the same directory (or GitHub repo) without using external storage.