kotori 3.0.0 → 3.0.2

package/README.md

@@ -61,7 +61,7 @@ npm i kotori
 **utils.ts**
 
 ```ts
-import { kotori } from './kotori'
+import { kotori } from 'kotori'
 
 export const { useT, dict, setLanguage } = kotori({
     primaryLanguageTag: 'en',
@@ -166,16 +166,29 @@ export const Page2 = () => {
 
 Creates a scoped i18n instance.
 
+```ts
+import { kotori } from 'kotori'
+
+export const { useT, dict, setLanguage } = kotori({
+    primaryLanguageTag: 'en',
+    secondaryLanguageTags: ['zh', 'ja', 'ms'],
+})
+```
+
 | option | type | description |
 | --- | --- | --- |
-| `primaryLanguageTag` | `AllTags` | The source language. Drives variable inference. |
-| `secondaryLanguageTags` | `AllTags[]` | Additional supported languages. |
+| `primaryLanguageTag` | `BCP47LanguageTag` | The source language. Drives variable inference. |
+| `secondaryLanguageTags` | `BCP47LanguageTag[]` | Additional supported languages. |
 
 Returns `{ dict, useT, setLanguage }`.
 
-### `dict(translations)<argsType?>`
+### `dict(Record<primaryLanguageTag | secondaryLanguageTags, string>)<argsType?>`
+
+Defines a translation unit. Takes one string per language.
 
-Defines a translation unit. Takes one string per language. Optionally takes a generic to narrow the interpolated variable types.
+```ts
+const time = dict({ en: '{{hour}}:{{minute}}' })
+```
 
 By default, variables are typed as `string | number`. Pass a generic to narrow them:
 
@@ -198,7 +211,7 @@ React hook. Returns `{ t, language, setLanguage }`.
 | --- | --- | --- |
 | `t(dict, args?)` | `string` | Returns the translated string for the current language. `args` is required if the string has variables, omitted if it doesn't. |
 | `language` | `primaryLanguageTag` \| `secondaryLanguageTags` | The current language tag as a reactive value. Updates when `setLanguage` is called. |
-| `setLanguage(tag)` | `void` | Updates the language and rerenders all active `useT` consumers. |
+| `setLanguage(primaryLanguageTag \| secondaryLanguageTags)` | `void` | Updates the language and rerenders all active `useT` consumers. |
 
 ## Language Tags
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "kotori",
 	"description": "Strongly-typed and composable internationalization library for React",
-	"version": "3.0.0",
+	"version": "3.0.2",
 	"scripts": {
 		"setup": "rm -rf node_modules && npm i && git init && husky",
 		"prepublishOnly": "npm i && npx tsc && npm run build",