From 2e97db7d1d95aaddbf557c43d4e5334a8c5d8e03 Mon Sep 17 00:00:00 2001
From: Ivan Ruiz Manuel <72193617+irm-codebase@users.noreply.github.com>
Date: Thu, 2 Apr 2026 15:57:58 +0200
Subject: [PATCH 1/2] readme reshuffle

---
 template/README.md.jinja | 49 +++++++++++++++++++++-------------------
 1 file changed, 26 insertions(+), 23 deletions(-)

diff --git a/template/README.md.jinja b/template/README.md.jinja
index 49b55e4..dbaa545 100644
--- a/template/README.md.jinja
+++ b/template/README.md.jinja
@@ -2,16 +2,34 @@
 
 {{module_description}}
 
-## About this module
+<!-- Place an attractive image of module outputs here -->
+
+
+## About
 <!-- Please do not modify this templated section -->
 
-This is a modular `snakemake` workflow built for [Modelblocks](https://www.modelblocks.org/) data modules.
+This is a modular `snakemake` workflow created as part of the [Modelblocks project](https://www.modelblocks.org/). It can be imported directly into any `snakemake` workflow.
+
+For more information, please consult the Modelblocks [documentation](https://modelblocks.readthedocs.io/en/latest/),
+the [integration example](./tests/integration/Snakefile),
+and the `snakemake` [documentation](https://snakemake.readthedocs.io/en/stable/snakefiles/modularization.html).
+
+## Overview
+<!-- Please describe the processing stages of this module here -->
+
+Data processing steps:
+1.
+2.
+
+## Configuration
+<!-- Please describe how to configure this module below -->
+
+Please consult the configuration [README](./config/README.md) and the [configuration example](./config/config.yaml) for a general overview on the configuration options of this module.
+
+## Input / output structure
+<!-- Please describe input / output file placement below -->
 
-This module can be imported directly into any `snakemake` workflow.
-For more information, please consult:
-- The Modelblocks [documentation](https://modelblocks.readthedocs.io/en/latest/).
-- The integration example in this repository (`tests/integration/Snakefile`).
-- The `snakemake` [documentation on modularisation](https://snakemake.readthedocs.io/en/stable/snakefiles/modularization.html).
+Please consult the [interface file](./INTERFACE.yaml) for more information.
 
 ## Development
 <!-- Please do not modify this templated section -->
@@ -39,22 +57,7 @@ cd tests/integration/  # navigate to the integration example
 snakemake --use-conda --cores 2  # run the workflow!
 ```
 
-## Documentation
-
-### Overview
-<!-- Please describe the processing stages of this module here -->
-
-### Configuration
-<!-- Feel free to describe how to configure this module below -->
-
-Please consult the configuration [README](./config/README.md) and the [configuration example](./config/config.yaml) for a general overview on the configuration options of this module.
-
-### Input / output structure
-<!-- Feel free to describe input / output file placement below -->
-
-Please consult the [interface file](./INTERFACE.yaml) for more information.
-
-### References
+## References
 <!-- Please provide thorough referencing below -->
 
 This module is based on the following research and datasets:

From 4cce1f444f388e30f6850188ff14a595cccda151 Mon Sep 17 00:00:00 2001
From: Ivan Ruiz Manuel <72193617+irm-codebase@users.noreply.github.com>
Date: Thu, 2 Apr 2026 16:12:41 +0200
Subject: [PATCH 2/2] update release workflow permissions

---
 template/.github/workflows/release.yml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/template/.github/workflows/release.yml b/template/.github/workflows/release.yml
index 7cb7539..7e25226 100644
--- a/template/.github/workflows/release.yml
+++ b/template/.github/workflows/release.yml
@@ -6,4 +6,6 @@ on:
 
 jobs:
   release-workflow:
+    permissions:
+      contents: write
     uses: modelblocks-org/data-module-template/.github/workflows/template-release.yml@latest