From f69e7779e42f18df7ec3ccb1cdf9dcf7fa845ee6 Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Fri, 5 Feb 2021 22:23:48 +0100 Subject: [PATCH] Updated readme ref #5 --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bfe370d..bc8cedb 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 handlebars for templateing utilizing i18next for translation. +We use handlebars for templateing utilizing i18next for translation - the i18n string format in the templates is : `{{__ "string"}}` 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: @@ -47,7 +47,8 @@ The server currently needs the following templates to work: | Template Data | Type | Optional | Description | - | - | - | - -| runner | object(Runner) | ❌ | The runner object. +| runners | array(Runner) | ❌ | The runner objects. We generate a contract for each runner on a new DIN-A5 page. + ## Recommended Editor @@ -56,6 +57,7 @@ The server currently needs the following templates to work: ### Recommended Extensions * will be automatically recommended via ./vscode/extensions.json +* we also provide a config for i18n-ally in the .vscode folder ## Staging ### Branches & Tags