From ea7db635cd4d97dba350a286548233654d9bd0d5 Mon Sep 17 00:00:00 2001 From: Claire Saba Date: Thu, 8 Feb 2024 18:11:45 +0100 Subject: [PATCH] doc(readme): add renderJsonSchema function to readme --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 2825bf3..f9db87e 100644 --- a/README.md +++ b/README.md @@ -29,3 +29,6 @@ The implemented functions are: - `getLocalizedDescription`: - takes in parameters a schema with localized descriptions, the locale for which we want the description and optionnaly the locale of the default description (default value is `'en'`) - returns the description for the wanted locale, or `undefined` if not found +- `renderJsonSchema`: + - takes in parameters a schema with localized descriptions, the locale for which we want the description and optionnaly the locale of the default description (default value is `'en'`) + - returns the `JSONSchema6` equivalent with the selected locale