Add docs

Author: webkong

.DS_Store

@@ -1,19 +1,14 @@
 {
-    "env": {
-        "browser": true,
-        "es2021": true
-    },
-    "extends": [
-        "standard"
-    ],
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "ecmaVersion": 12,
-        "sourceType": "module"
-    },
-    "plugins": [
-        "@typescript-eslint"
-    ],
-    "rules": {
-    }
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": ["standard"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint"],
+  "rules": {}
 }

.eslintrc.json

@@ -0,0 +1,2 @@
+examples/*
+packages/*

.npmignore

@@ -1,128 +1,19 @@
-# vue3-i18n
+<h1 align="center">Vue3-i18n</h1>
 
-![Vue 3.x](https://img.shields.io/badge/vue-3.x-green.svg "Vue 3 Compatible")
+<p align="center">Internationalization plugin for Vue.js 3.0</p>
 
-I18n for vue3.
+## :warning: NOTICE
 
-**Note:**
+This repository is for Vue3-i18n.
 
-Issue/PR is welcomed, I'll response as soon as possible.
+## :book: Documentation
 
-If you like this pack, can give a star.
+About Vue3 I18n, See [here](https://vue3-i18n.webkong.cn)
 
-## install
+## :scroll: Changelog
 
-`npm install vue3-i18n --save`
+Detailed changes for each release are documented in the [CHANGELOG.md](https://github.com/webkong/vue3-i18n/blob/master/CHANGELOG.md).
 
-## Quickstart
+## :copyright: License
 
-```javascript
-// i18n.js
-import { createI18n } from "vue3-i18n";
-
-const messages = {
-  en: {
-    menu: ["Home"],
-    test: "test",
-    object: {
-      a: "1233",
-    },
-    parse: "welcome to {name}",
-    parses: {
-      a: "welcome to {name}",
-    },
-  },
-  zh: {
-    menu: ["首页"],
-    test: "测试",
-    object: {
-      a: "1233",
-    },
-    parse: "welcome to {name}",
-    parses: {
-      a: "welcome to {name}",
-    },
-  },
-};
-
-const i18n = createI18n({
-  locale: "en",
-  messages: messages,
-});
-
-export default i18n;
-```
-
-```javascript
-// main.js
-import { createApp } from "vue";
-import i18n from "./i18n";
-
-const app = createApp(App);
-
-app.use(i18n).mount("#app");
-```
-
-## Usage
-
-```html
-<p>{{ $t("test") }}</p>
-<!-- array -->
-<p>{{ $t("menu[0]") }}</p>
-<!-- object -->
-<p>{{ $t("object.a") }}</p>
-<!-- parse -->
-<p>{{ $t("parse", { name: "wangsw" }) }}</p>
-<p>{{ $t("parses.a", { name: "wangsw" }) }}</p>
-```
-
-```javascript
-<script>
-import { useI18n } from "vue3-i18n";
-export default {
-  setup() {
-    const i18n = useI18n();
-    const setLocale = (lang) => {
-      i18n.setLocale(lang);
-    };
-
-    return {
-      setLocale,
-    };
-  },
-};
-</script>
-```
-
-### API
-
-### i18n.t(key,parmas)
-
-| t()    | Type     | Description     |
-| ------ | -------- | --------------- |
-| key    | `string` | translate text  |
-| params | `object` | format params   |
-| return | `string` | translated text |
-
-### i18n.setLocale()
-
-| setLocale() | Type     | Description |
-| ----------- | -------- | ----------- |
-| params      | `string` | set locale  |
-| return      | `void`   |             |
-
-### i18n.getLocale()
-
-| getLocale() | Type     | Description    |
-| ----------- | -------- | -------------- |
-| params      | `void`   |                |
-| return      | `string` | current locale |
-
-## TODO
-
-- [ ] directive
-- [x] Named formatting
-
-## License
-
-MIT
+[MIT](http://opensource.org/licenses/MIT)

CHANGELOG.md

@@ -6,8 +6,6 @@ export interface I18nConfig {
     locale?: string;
     messages: Messages;
 }
-export interface Params extends Object {
-}
 export interface I18nInstance {
     messages: Messages;
     t: (key: string) => string;