From ec56d49b16405bd53bb8dd27ec67c246cc6d9a65 Mon Sep 17 00:00:00 2001 From: Drew Heavner Date: Thu, 30 Jan 2020 11:53:11 -0500 Subject: [PATCH] Update README.md --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6d2e7840..f83872f2 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,21 @@ Portion of users who should get the staged version of the app. Accepts values be ### `whatsNewDirectory` -The directory of localized whats new files to upload as the release notes. Using the pattern `whatsnew-` -i.e. `whatsnew-en-US`. Where `LOCALE` is using the [`BCP 47`](https://tools.ietf.org/html/bcp47) format, for example: +The directory of localized whats new files to upload as the release notes. The files contained in the `whatsNewDirectory` MUST use the pattern `whatsnew-` where `LOCALE` is using the [`BCP 47`](https://tools.ietf.org/html/bcp47) format, e.g. * `en-US` - English/America * `de-DE` - German/Germany -* `ja-JP` - Japanese/Japan +* `ja-JP` - Japanese/Japan + +and contain plain `utf8` encoded text with no extension on the file. The resulting directory in your project should look something like this: +``` +projectDir/ +└── whatsNewDirectory/ + ├── whatsnew-en-US + ├── whatsnew-de-DE + └── whatsnew-ja-JP +``` +where `whatsNewDirectory` is the path you pass to the action. + ### `mappingFile` @@ -50,4 +60,4 @@ with: userFraction: 0.33 whatsNewDirectory: /distribution/whatsnew mappingFile: /app/build/outputs/mapping/release/mapping.txt -``` \ No newline at end of file +```