From 05e471878f2321a1873b21730ae85ad6b8af5766 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Fri, 5 Feb 2021 21:29:21 +0100 Subject: [PATCH] Updated readme for handlebars ref #5 --- README.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 57fc0ee..bfe370d 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ The basic generation mechanism makes the templates and routes interchangeable (i > The templates are stored in src/templates by default. We provide a set of default templates that we use for the ["Lauf für Kaya!" charity run](https://lauf-fuer-kaya.de). -We use mustache-style templating strings to fill the templates with real information (exact strings are explained below). +We use handlebars for templateing utilizing i18next for translation. You can provide your own templates by replacing the ones we provided before compiling the project or by simply mounting your custom templates into the docker container. The server currently needs the following templates to work: @@ -45,12 +45,9 @@ The server currently needs the following templates to work: ### Sponsoring Contracts -| Template String | Type | Optional | Description +| Template Data | Type | Optional | Description | - | - | - | - -| runner_firstname | string | ❌ | The runner's first name -| runner_middlename | string | ✅ | The runner's middle name -| runner_lastname | string | ❌ | The runner's last name -| runner_id | int | ❌ | The runner's id +| runner | object(Runner) | ❌ | The runner object. ## Recommended Editor