piral-blazor - npm Package Compare versions

Comparing version 0.11.3-pre.1117 to 0.11.3-pre.1120

package.json

 {
   "name": "piral-blazor",
-  "version": "0.11.3-pre.1117",
+  "version": "0.11.3-pre.1120",
   "description": "Plugin for integrating Blazor components in Piral.",
@@ -48,3 +48,3 @@ "keywords": [
     "@types/emscripten": "0.0.34",
-    "piral-core": "^0.11.3-pre.1117"
+    "piral-core": "^0.11.3-pre.1120"
   },
@@ -54,3 +54,3 @@ "peerDependencies": {
   },
-  "gitHead": "b5a72285ad07aaa9716bd00a3f09cdf50ac7ee4e"
+  "gitHead": "372cfcab109f1329fc446082d0b0f48e2d00f6eb"
 }

README.md

@@ -13,2 +13,21 @@ [![Piral Logo](https://github.com/smapiot/piral/raw/master/docs/assets/logo.png)](https://piral.io)
 
+As Blazor is quite a special technology (since its based on WebAssembly) there are some very special things to follow for integration. The result, however, could be worth it. As Piral gives you here a truly unique and wonderful way of building your application - modular, distributed, and with the fastest possible Blazor startup time!
+
+**Important**:
+We recommend building pilets for `piral-blazor` exclusively with the official template.
+
+The template can be installed using the `dotnet` CLI:
+
+```sh
+dotnet new -i Piral.Blazor.Template
+```
+
+Then you can always apply the template in an empty folder:
+
+```sh
+dotnet new blazorpilet --piralInstance my-app-shell
+```
+
+where `my-app-shell` should refer to the name of the NPM package of your app shell. The `--npmRegistry` option is there, to cover cases where your app shell is not hosted in the standard NPM registry.
+
 The following functions are brought to the Pilet API.
@@ -20,2 +39,4 @@
 
+When you use the `blazorpilet` template you don't need to fill / use this. It is automatically used and filled with generated code. Only touch this one if you know what you are doing.
+
 ### `fromBlazor()`
@@ -25,2 +46,4 @@
 
+There is only a single argument, which refers to the name of the exposed Blazor component.
+
 ## Usage
@@ -39,4 +62,4 @@
   piral.defineBlazorReferences([
+    require.resolve('./My.Dependency.dll'),
     require.resolve('./My.Components.dll'),
-    require.resolve('./My.Dependency.dll'),
   ])
@@ -43,0 +66,0 @@ piral.registerPage('/sample', piral.fromBlazor('sample-page'));

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

388995

increased by0.3%

Number of lines in readme file

99

increased by30.26%

No dependency changes