piral-ember 1.9.0-beta.8182 → 1.9.0-beta.8196

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +8 -19
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -18,18 +18,19 @@ Transforms a standard Ember.js component into a component that can be used in Pi
18
18
 
19
19
  ## Usage
20
20
 
21
- ::: summary: For pilet authors
21
+ ::: summary: Modern Use (recommended)
22
22
 
23
- You can use the `fromEmber` function from the Pilet API to convert your Ember.js components to components usable by your Piral instance.
23
+ The recommended way is to use `piral-ember` from your pilets. In this case, no registration in the Piral instance is required.
24
24
 
25
25
  Example use:
26
26
 
27
27
  ```ts
28
28
  import { PiletApi } from '<name-of-piral-instance>';
29
+ import { fromEmber } from 'piral-ember/convert';
29
30
  import { Page } from './Page';
30
31
 
31
32
  export function setup(piral: PiletApi) {
32
- piral.registerPage('/sample', piral.fromEmber(Page));
33
+ piral.registerPage('/sample', fromEmber(Page));
33
34
  }
34
35
  ```
35
36
 
@@ -38,22 +39,11 @@ Within Ember.js components the Piral Ember.js extension component can be used by
38
39
  ```html
39
40
  <ember-extension name="name-of-extension"></ember-extension>
40
41
  ```
41
-
42
- Alternatively, if `piral-ember` has not been added to the Piral instance you can install and use the package also from a pilet directly.
43
-
44
- ```ts
45
- import { PiletApi } from '<name-of-piral-instance>';
46
- import { fromEmber } from 'piral-ember/convert';
47
- import { Page } from './Page';
48
-
49
- export function setup(piral: PiletApi) {
50
- piral.registerPage('/sample', fromEmber(Page));
51
- }
52
- ```
53
-
54
42
  :::
55
43
 
56
- ::: summary: For Piral instance developers
44
+ ::: summary: Legacy Use
45
+
46
+ For backwards compatibility, you can also install `piral-ember` in your Piral instance.
57
47
 
58
48
  Using Ember.js with Piral is as simple as installing `piral-ember` and `ember-source@^3`.
59
49
 
@@ -70,9 +60,8 @@ const instance = createInstance({
70
60
  // ...
71
61
  });
72
62
  ```
73
-
74
63
  :::
75
64
 
76
65
  ## License
77
66
 
78
- Piral is released using the MIT license. For more information see the [license file](./LICENSE).
67
+ Piral is released using the MIT license. For more information see the [license file](./LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "piral-ember",
3
- "version": "1.9.0-beta.8182",
3
+ "version": "1.9.0-beta.8196",
4
4
  "description": "Plugin for integrating Ember.js components in Piral.",
5
5
  "keywords": [
6
6
  "piral",
@@ -53,7 +53,7 @@
53
53
  "devDependencies": {
54
54
  "@types/ember": "^3.1.1",
55
55
  "ember-source": "^3.15.0",
56
- "piral-core": "1.9.0-beta.8182"
56
+ "piral-core": "1.9.0-beta.8196"
57
57
  },
58
- "gitHead": "495aa779b7e4482a1515f1e5a2a591f907c6a052"
58
+ "gitHead": "73f7d0d90884d0b1dc1cc5ed7965f0cb0bc48a20"
59
59
  }