genshin-text 4.4.0 → 4.6.0

package/README.md

@@ -5,9 +5,7 @@
 [![NPM downloads][badge-npm-downloads]][url-npm]
 [![NPM Unpacked Size (with version)][badge-npm-unpacked-size]][url-npm]
 
-Genshin Impact's own text in its fifteen languages, as an unofficial, non-commercial fan work and not affiliated with HoYoverse.
-
-Nothing is translated by hand: each string is the game's own, in the game's own translation.
+Genshin Impact's own text in its fifteen languages, none translated by hand. It is an unofficial, non-commercial fan work, not affiliated with HoYoverse.
 
 Design notes live in [the specs](https://github.com/Esposter/Esposter/tree/main/openspec/specs/genshin/game-text).
 
@@ -25,7 +23,9 @@ Design notes live in [the specs](https://github.com/Esposter/Esposter/tree/main/
 pnpm i genshin-text
 ```
 
-Pick the reader's language, load its text once, and index it by key:
+1. Pick the reader's language with `matchGameLanguage`. Pass in the browser's language list.
+2. Load that language's text once with `GameTextLoaderMap`.
+3. Index the text with a `GameTextKey` value.
 
 ```ts
 import { GameTextKey, GameTextLoaderMap, matchGameLanguage } from "genshin-text";
@@ -35,20 +35,22 @@ const gameText = await GameTextLoaderMap[language]();
 console.log(gameText[GameTextKey.Loading]);
 ```
 
+Check: the console shows the loading string in the reader's language, or in English when no language of the fifteen matches.
+
 ## <a name="key-exports">🧩 Key Exports</a>
 
-| Export                   | Kind      | Purpose                                                                                        |
-| ------------------------ | --------- | ---------------------------------------------------------------------------------------------- |
-| `fillGameTextValues`     | function  | Fills a string's numbered placeholders with the values given, keeping any with no value        |
-| `GameLanguage`           | enum      | The fifteen languages the game is written in                                                   |
-| `GameText`               | type      | Every referenced string in one language, keyed by `GameTextKey`                                |
-| `GameTextKey`            | enum      | Every string a consumer shows, by the game's own text id                                       |
-| `GameTextLoaderMap`      | const     | Loads one language's `GameText`: English bundled, every other language a chunk on first use    |
-| `GameTextSegment`        | interface | A run of a game string under one colour, or plain when it has none                             |
-| `getAcceptLanguageTags`  | function  | The tags of an `Accept-Language` header, most preferred first, weighed by their `q`            |
-| `getLanguageDisplayName` | function  | A game language's name as written in another game language, or as given when either is not one |
-| `matchGameLanguage`      | function  | The game language nearest a list of preferred tags, English when none matches                  |
-| `splitGameTextColors`    | function  | Splits a game string into plain runs and colour-tagged runs                                    |
+| Export                   | Kind      | Purpose                                                                                                              |
+| ------------------------ | --------- | -------------------------------------------------------------------------------------------------------------------- |
+| `fillGameTextValues`     | function  | Fills a string's numbered placeholders with the values given, and keeps each placeholder that has no value           |
+| `GameLanguage`           | enum      | The fifteen languages of the game                                                                                    |
+| `GameText`               | type      | Every referenced string in one language, keyed by `GameTextKey`                                                      |
+| `GameTextKey`            | enum      | Every string that a consumer shows, by the game's own text id                                                        |
+| `GameTextLoaderMap`      | const     | Loads one language's `GameText`: English is bundled, and each other language is a chunk loaded on first use          |
+| `GameTextSegment`        | interface | A run of a game string under one colour, or plain when it has none                                                   |
+| `getAcceptLanguageTags`  | function  | The tags of an `Accept-Language` header, most preferred first, weighed by their `q`                                  |
+| `getLanguageDisplayName` | function  | A game language's name, as written in another game language, or the name as given when either is not a game language |
+| `matchGameLanguage`      | function  | The game language nearest to a list of preferred tags, or English when none matches                                  |
+| `splitGameTextColors`    | function  | Splits a game string into plain runs and colour-tagged runs                                                          |
 
 ## <a name="license">⚖️ License</a>