docs: Improve Documentation

xiCO2k · xiCO2k · commit f26563398426 · 2021-11-18T13:48:46.000Z
diff --git a/README.md b/README.md
@@ -1,6 +1,27 @@
-# Laravel Vue i18n
+<h1 align="center" style="border:none !important">
+    Laravel Vue i18n
+</h1>
 
-**laravel-vue-i18n** allows to connect your `Laravel` Framework translation files with `Vue`.
+<p align="center">
+    <a href="https://github.com/xiCO2k/laravel-vue-i18n/actions"><img alt="GitHub Workflow Status (master)" src="https://img.shields.io/github/workflow/status/xiCO2k/laravel-vue-i18n/Tests/master"></a>
+    <a href="https://www.npmjs.com/package/laravel-vue-i18n"><img alt="License" src="https://img.shields.io/npm/l/laravel-vue-i18n.svg?sanitize=true"></a>
+</p>
+
+<p align="center">
+    <b>laravel-vue-i18n</b> is a <b>Vue3</b> plugin that allows to connect your <b>Laravel</b> Framework <b>JSON</b> translation
+    files with <b>Vue</b>. It uses the same logic used on <a href="https://laravel.com/docs/8.x/localization">Laravel Localization</a>.
+</p>
+
+## Installation
+With [npm](https://www.npmjs.com):
+```sh
+$ npm i laravel-vue-i18n
+```
+
+or with [yarn](https://yarnpkg.com):
+```sh
+$ yarn add laravel-vue-i18n
+```
 
 ## Usage
 
@@ -23,6 +44,9 @@ createApp()
 
 ### Plugin Options
 
+- `lang` *(optional)*: if not provided it will try to find from the `<html lang="pt">` tag, if is not available it will default to `en`.
+- `resolve`: The way to reach your language files.
+
 ```js
 createApp().use(i18nVue, {
     lang: 'pt',
@@ -32,6 +56,8 @@ createApp().use(i18nVue, {
 
 ### trans()
 
+The `trans()` method can be used on
+
 ```js
 // lang/pt.json
 {
diff --git a/src/index.ts b/src/index.ts
@@ -89,6 +89,9 @@ export function trans(key: string, replacements?: ReplacementsInterface): string
   return message
 }
 
+/**
+ * The Vue Plugin. to be used on your Vue app like this: `app.use(i18nVue)`
+ */
 export const i18nVue: Plugin = {
   install: (app, currentOptions: OptionsInterface = {}) => {
     options = { ...options, ...currentOptions }

Original file line number	Diff line number	Diff line change
`@@ -89,6 +89,9 @@ export function trans(key: string, replacements?: ReplacementsInterface): string`
`89`	`89`	`return message`
`90`	`90`	`}`
`91`	`91`
	`92`	`+/**`
	`93`	+ * The Vue Plugin. to be used on your Vue app like this: `app.use(i18nVue)`
	`94`	`+ */`
`92`	`95`	`export const i18nVue: Plugin = {`
`93`	`96`	`install: (app, currentOptions: OptionsInterface = {}) => {`
`94`	`97`	`options = { ...options, ...currentOptions }`