From ce5e7df6caf20471917078710783826a5c07ecd4 Mon Sep 17 00:00:00 2001 From: Jeroen Claessens Date: Tue, 19 Apr 2022 10:32:53 +0200 Subject: [PATCH 1/3] docs: added remark about component libraries --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 9dcec78..068cae4 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,12 @@ Publish your plugin and all is done! > }) > ``` +### Remark + +`Vue Demi` is only supposed to work with libraries/plugins that use the `@vue/composition-api`, that are **not** components (e.g. `VueUse`, `Pinia`, ...). In other words, you can't use a `Vue3` compiled library in a `Vue2` project and vice versa, because they use different compilers. + +In order to build a component library/plugin for both `Vue2` and `Vue3` you could either publish plain `Vue` files or build your library seperately for `Vue2` and `Vue3`. Both options can be tricky because there are a few differences in their runtime APIs. + ### Extra APIs `Vue Demi` provides extra APIs to help distinguish users' environments and to do some version-specific logic. From 0657075f67f7bff0993a4379cb7ccbf97131dac4 Mon Sep 17 00:00:00 2001 From: Jeroen Claessens Date: Tue, 19 Apr 2022 12:28:35 +0200 Subject: [PATCH 2/3] docs: clarify remark --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 068cae4..c2979d0 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ Publish your plugin and all is done! ### Remark -`Vue Demi` is only supposed to work with libraries/plugins that use the `@vue/composition-api`, that are **not** components (e.g. `VueUse`, `Pinia`, ...). In other words, you can't use a `Vue3` compiled library in a `Vue2` project and vice versa, because they use different compilers. +`Vue Demi` is mainly supposed to work with libraries/plugins that use the `@vue/composition-api` that are **not** components (e.g. `VueUse`, `Pinia`, ...). In other words, you need to be cautious to work with `Vue SFC` because the SFC compilation process and the results are different across `Vue 2` and `Vue 3`. In order to build a component library/plugin for both `Vue2` and `Vue3` you could either publish plain `Vue` files or build your library seperately for `Vue2` and `Vue3`. Both options can be tricky because there are a few differences in their runtime APIs. From da0083fafe3c834e082380e6ad5ea32c9ddeef41 Mon Sep 17 00:00:00 2001 From: Jeroen Claessens Date: Tue, 19 Apr 2022 13:00:32 +0200 Subject: [PATCH 3/3] docs: fix spelling --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c2979d0..1115a70 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ Publish your plugin and all is done! `Vue Demi` is mainly supposed to work with libraries/plugins that use the `@vue/composition-api` that are **not** components (e.g. `VueUse`, `Pinia`, ...). In other words, you need to be cautious to work with `Vue SFC` because the SFC compilation process and the results are different across `Vue 2` and `Vue 3`. -In order to build a component library/plugin for both `Vue2` and `Vue3` you could either publish plain `Vue` files or build your library seperately for `Vue2` and `Vue3`. Both options can be tricky because there are a few differences in their runtime APIs. +In order to build a component library/plugin for both `Vue2` and `Vue3` you could either publish plain `Vue` files or build your library separately for `Vue2` and `Vue3`. Both options can be tricky because there are a few differences in their runtime APIs. ### Extra APIs