@yiiamee/multilinguist 1.0.14 → 1.1.1

package/README.md

@@ -1,18 +1,99 @@
 # Nuxt MultiLinguist module
 
-[![npm version][npm-version-src]][npm-version-href]
-[![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![License][license-src]][license-href]
-[![Nuxt][nuxt-src]][nuxt-href]
+Multilinguist is simple, but smoothly working module for easy and seamless localization implementation in Nuxt 3. 
 
-This module is a simple, but smoothly working module for easy and seamless localization implementation in Nuxt 3. 
+## Key Features
 
-## Features
+- Easy translations that you're used to
+- Works perfectly fine on both SSR + CSR
+- No memory leaks and running out of memory errors
+- Autocompletion & validation of keys
 
-## Quick Setup
-
-Install the module to your Nuxt application with one command:
+## Installation
 
 ```bash
-npx nuxi module add @nuxtjs/multilinguist
+npm install @yiiamee/multilinguist
+```
+
+Then, add the module to your nuxt.config
+
+```nuxt.config.ts
+export default defineNuxtConfig({
+    modules: [
+        @yiiamee/multilinguist,
+    ],
+    multilinguist: {
+        defaultLocale: "en", // string representing key to your default (fallback) locale
+        supportedLanguages: ["en", "es"], // array of strings representing all available locales' keys
+    },
+})
+```
+
+Then, create a "locales" directory in /public directory. This is necessary for module to access your languages.
+
+![directory_structure.png](directory_structure.png)
+
+Now, you're ready to use Multilinguist Module!
+
+### t()—famous translate function 
+ 
+```vue
+<script setup lang="ts">
+const { t } = useMultilinguist(); // Call useMultilinguist composable to get the translate function
+  
+const pageTitle = computed(() => {
+  return t("Hello, World");
+});
+</script> 
+
+<template>
+  <h3>{{ pageTitle }}</h3>
+  <button>{{ t("Switch Locale") }}</button>
+</template>
+```
+
+You can already see how the keys auto-completion works:
+
+![autocompletion.png](autocompletion.png)
+
+And validation:
+
+![validation.png](validation.png)
+
+### Set another value to current locale:
+
+```vue
+<script setup lang="ts">
+const { t, setLocale } = useMultilinguist();
+// setLocale function accepts string, that should match one of defined
+// in the nuxt.config strings from supportedLanguages array
+  
+const pageTitle = computed(() => {
+  return t("Hello, World");
+});
+</script> 
+
+<template>
+  <h3>{{ pageTitle }}</h3>
+  <button @click="setLocale('es')">{{ t("Switch Locale") }}</button>
+</template>
+```
+
+### Get current locale
+
+```vue
+<script setup lang="ts">
+const { t, setLocale, locale } = useMultilinguist();
+// locale is SSR friendly, shared among the app ref state  
+
+const pageTitle = computed(() => {
+    return t("Hello, World");
+});
+</script>
+
+<template>
+  <h3>{{ pageTitle }}</h3>
+  <h6>Current Locale: {{ locale }}</h6>
+  <button @click="setLocale('es')">{{ t("Switch Locale") }}</button>
+</template>
 ```

package/dist/runtime/plugin.js

@@ -7,10 +7,10 @@ export default defineNuxtPlugin(async (nuxtApp) => {
   };
   const supportedLanguages = config.supportedLanguages;
   const defaultLocale = config.defaultLocale;
-  const localization = useLocalization(supportedLanguages, defaultLocale);
-  await localization.initLocalization();
-  console.log("[multilinguist] is initialised", config.supportedLanguages, config.defaultLocale);
-  nuxtApp.provide("localization", localization);
-  nuxtApp.provide("t", localization.t);
-  nuxtApp._localization = localization;
+  const { initLocalization, ...localizationProperties } = useLocalization(supportedLanguages, defaultLocale);
+  await initLocalization();
+  console.log("[multilinguist] is initialised");
+  nuxtApp.provide("localization", localizationProperties);
+  nuxtApp.provide("t", localizationProperties.t);
+  nuxtApp._localization = localizationProperties;
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yiiamee/multilinguist",
-  "version": "1.0.14",
+  "version": "1.1.1",
   "description": "Nuxt 3 Multilinguist Localization module",
   "repository": "yiiameeMich/multilinguist",
   "license": "MIT",