piral-elm 1.9.0-beta.8186 → 1.9.0-beta.8209

package/README.md

@@ -18,18 +18,19 @@ Transforms a standard Elm component into a component that can be used in Piral,
 
 ## Usage
 
-::: summary: For pilet authors
+::: summary: Modern Use (recommended)
 
-You can use the `fromElm` function from the Pilet API to convert your Elm components to components usable by your Piral instance.
+The recommended way is to use `piral-elm` 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 { fromElm } from 'piral-elm/convert';
 import Elm from './Page.elm';
 
 export function setup(piral: PiletApi) {
-  piral.registerPage('/sample', piral.fromElm(Elm.Page));
+  piral.registerPage('/sample', fromElm(Elm.Page));
 }
 ```
 
@@ -38,22 +39,11 @@ Within Elm components the Piral Elm extension component can be used by referring
 ```html
 <elm-extension name="name-of-extension"></elm-extension>
 ```
-
-Alternatively, if `piral-elm` 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 { fromElm } from 'piral-elm/convert';
-import Elm from './Page.elm';
-
-export function setup(piral: PiletApi) {
-  piral.registerPage('/sample', fromElm(Elm.Page));
-}
-```
-
 :::
 
-::: summary: For Piral instance developers
+::: summary: Legacy Use
+
+For backwards compatibility, you can also install `piral-elm` in your Piral instance.
 
 Using Elm with Piral is as simple as installing `piral-elm`.
 
@@ -70,7 +60,6 @@ const instance = createInstance({
   // ...
 });
 ```
-
 :::
 
 ## Pilet Usage
@@ -156,4 +145,4 @@ Either way an *elm.json* will be created in the pilet root folder. It will look
 
 ## 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-elm",
-  "version": "1.9.0-beta.8186",
+  "version": "1.9.0-beta.8209",
   "description": "Plugin for integrating Elm components in Piral.",
   "keywords": [
     "piral",
@@ -51,7 +51,7 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "devDependencies": {
-    "piral-core": "1.9.0-beta.8186"
+    "piral-core": "1.9.0-beta.8209"
   },
-  "gitHead": "ff7d73f1903c20eb9f14e58b21f33d36dee8f572"
+  "gitHead": "6ae23abba61e76479bc06b76454c38957bc0e79e"
 }