From 37c5b8be7e1a9b86363fc23ddb08c4a1f6643c0c Mon Sep 17 00:00:00 2001 From: Danny Hammer Date: Thu, 27 Jun 2024 12:39:01 -0600 Subject: [PATCH] fix: adjusted displayData.json to have localizedDisplayInfo field --- README.md | 9 +++++---- contributions/displayData.json | 12 +++++++----- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 0af8213..06607ae 100644 --- a/README.md +++ b/README.md @@ -44,13 +44,14 @@ To make the process of customizing from the template as smooth as possible, we r - In `contributions/displayData.json`: - If your extension has an icon, update the `icon` value to point towards the icon file (for example: `./assets/icon.svg`) - - Update the `en` entry so that: - + - Update the `en` entry of `localizedDisplayInfo` so that: + - `displayName` contains a human-readable name for your extension (i.e. `Your Extension Name`). - `shortSummary` contains a short, few sentence summary of what your extension does. - `description` points to a Markdown (`.md`) file containing the full description of your extension (similar to what you would put in a `README`). - - If your extension supports multiple languages, copy and paste the `en` entry, changing `en` to the [BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the language you want to support, and translate the `displayName`, `shortSummary`, and `description` fields appropriately. We recommend naming your description files `description-.md`. - + + - If your extension supports multiple languages, add another entry to `localizedDisplayInfo` by copying and pasting the `en` entry, changing `en` to the [BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the language you want to support, and translating the `displayName`, `shortSummary`, and `description` fields appropriately. We recommend naming your description files `description-.md`. + - In `LICENSE`: - Adjust as desired (feel free to choose a different license) diff --git a/contributions/displayData.json b/contributions/displayData.json index bdca049..254963c 100644 --- a/contributions/displayData.json +++ b/contributions/displayData.json @@ -1,8 +1,10 @@ { "icon": "", - "en": { - "displayName": "Paranext Extension Template", - "shortSummary": "Base template for a Paranext Extension", - "description": "./description-en.md" + "localizedDisplayInfo": { + "en": { + "displayName": "Paranext Extension Template", + "shortSummary": "Base template for a Paranext Extension", + "description": "./description-en.md" + } } -} \ No newline at end of file +}