Skip to content

Commit 405a116

Browse files
author
Sebi Nemeth
committed
update readme
1 parent 661f104 commit 405a116

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
# Live Translator Plugin for Vue 2
1+
# Live Translator Plugin
2+
> [!WARNING]
3+
> Plugin has been updated to Vue 3 only. To use with Vue 2 please use the legacy `vue2` branch.
4+
5+
## Demo
6+
Find a live demo app at: [https://apicore-engineering.github.io/vue-i18n-live-translator-plugin/](https://apicore-engineering.github.io/vue-i18n-live-translator-plugin/)
27

38
## Install
49
```bash
@@ -7,10 +12,9 @@ npm i -s https://github.com/apicore-engineering/vue-i18n-live-translator-plugin
712

813
## Use
914
```typescript
10-
import LiveTranslatorPlugin, { TranslationMeta } from 'vue-i18n-live-translator-plugin'
15+
import { LiveTranslatorPlugin, TranslationMeta } from 'vue-i18n-live-translator-plugin'
1116

1217
Vue.use(LiveTranslatorPlugin, {
13-
i18n,
1418
translationLink (meta: TranslationMeta) {
1519
return '' // your platform-specific link to the translation software
1620
},
@@ -37,4 +41,7 @@ npm install
3741
```
3842
```bash
3943
husky install
44+
```
45+
```bash
46+
npm run dev # demo & dev app with vite
4047
```

0 commit comments

Comments
 (0)