piral-svelte 1.9.0-beta.8186 → 1.9.0-beta.8196

package/README.md

@@ -18,18 +18,19 @@ Transforms a standard Svelte component into a component that can be used in Pira
 
 ## Usage
 
-::: summary: For pilet authors
+::: summary: Modern Use (recommended)
 
-You can use the `fromSvelte` function from the Pilet API to convert your Svelte components to components usable by your Piral instance.
+The recommended way is to use `piral-svelte` from your pilets. In this case, no registration in the Piral instance is required.
 
 Example use:
 
 ```ts
 import { PiletApi } from '<name-of-piral-instance>';
+import { fromSvelte } from 'piral-svelte/convert';
 import SveltePage from './Page.svelte';
 
 export function setup(piral: PiletApi) {
-  piral.registerPage('/sample', piral.fromSvelte(SveltePage));
+  piral.registerPage('/sample', fromSvelte(SveltePage));
 }
 ```
 
@@ -39,18 +40,6 @@ Within Svelte components the Piral Svelte extension component can be used by ref
 <svelte-extension name="name-of-extension"></svelte-extension>
 ```
 
-Alternatively, if `piral-svelte` has not been added to the Piral instance you can install and use the package also from a pilet directly.
-
-```ts
-import { PiletApi } from '<name-of-piral-instance>';
-import { fromSvelte } from 'piral-svelte/convert';
-import SveltePage from './Page.svelte';
-
-export function setup(piral: PiletApi) {
-  piral.registerPage('/sample', fromSvelte(SveltePage));
-}
-```
-
 How you built your Svelte-pilet is up to you. If you use Webpack then the bundler options such as `piral-cli-webpack` or `piral-cli-webpack5` can be leveraged. In these cases you'd need to install the `svelte-loader` package and create a custom *webpack.config.js*:
 
 ```sh
@@ -111,10 +100,11 @@ module.exports = config => {
   return config;
 };
 ```
-
 :::
 
-::: summary: For Piral instance developers
+::: summary: Legacy Use
+
+For backwards compatibility, you can also install `piral-svelte` in your Piral instance.
 
 Using Svelte with Piral is as simple as installing `piral-svelte`. In the pilets using Svelte, `svelte` and `parcel-plugin-svelte` should be installed, too.
 
@@ -131,7 +121,6 @@ const instance = createInstance({
   // ...
 });
 ```
-
 :::
 
 ## Pilet Usage
@@ -187,4 +176,4 @@ Furthermore, since Svelte distributes its source code as ES6 we need to change t
 
 ## License
 
-Piral is released using the MIT license. For more information see the [license file](./LICENSE).
+Piral is released using the MIT license. For more information see the [license file](./LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "piral-svelte",
-  "version": "1.9.0-beta.8186",
+  "version": "1.9.0-beta.8196",
   "description": "Plugin for integrating Svelte components in Piral.",
   "keywords": [
     "piral",
@@ -53,7 +53,7 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "devDependencies": {
-    "piral-core": "1.9.0-beta.8186"
+    "piral-core": "1.9.0-beta.8196"
   },
-  "gitHead": "ff7d73f1903c20eb9f14e58b21f33d36dee8f572"
+  "gitHead": "73f7d0d90884d0b1dc1cc5ed7965f0cb0bc48a20"
 }