@appshell/config 0.3.0-alpha.6 → 0.3.0

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 (5) hide show
  1. package/README.md +6 -4
  2. package/dist/main.js +1 -1
  3. package/dist/types/generate.manifest.d.ts +2 -3
  4. package/dist/types/generate.manifest.d.ts.map +1 -1
  5. package/package.json +2 -2
package/README.md CHANGED
@@ -11,10 +11,12 @@
11
11
 
12
12
  # @appshell/config
13
13
 
14
- Utitliy for generating a `global appshell manifest` for Webpack Module federation micro-frontends.
14
+ Utitliy to generate appshell configuration for building micro-frontends with Appshell and Webpack Module federation.
15
15
 
16
16
  Working examples can be found [here](https://github.com/navaris/appshell/tree/main/examples).
17
17
 
18
+ **Note: This package is no longer published, and it's recommended to use the [@appshell/cli](https://www.npmjs.com/package/@appshell/cli) instead.**
19
+
18
20
  ## Getting Started
19
21
 
20
22
  To begin, you'll need to install `@appshell/config`:
@@ -98,7 +100,7 @@ Sample content from CONFIGS_DIR:
98
100
 
99
101
  > **Note** the `environment` section defines runtime environment variables that are injected into the global namesapce `window.__appshell_env__[module_name]` when a federated component is loaded. See the examples for a use case.
100
102
 
101
- Sample global appshell manifest produced by the `generate` function:
103
+ Sample appshell manifest produced by the `generateManifest` function:
102
104
 
103
105
  ```json
104
106
  {
@@ -191,8 +193,8 @@ Sample global appshell manifest produced by the `generate` function:
191
193
  }
192
194
  ```
193
195
 
194
- This `global appshell manifest` is consumed by your micro-frontend Appshell host and used to configure the Appshell accordingly.
196
+ This `appshell manifest` is registered with `APPSHELL_REGISTRY` consumed by the appshell host.
195
197
 
196
198
  **What if I want to generate the manifest by a startup script instead?**
197
199
 
198
- > This functionality is exposed by the [@appshell/cli](https://www.npmjs.com/package/@appshell/cli) package. You can simply call `appshell generate manifest --configsDir /path/to/appshell_configs` to produce the global runtime manifest on startup.
200
+ > This functionality is exposed by the [@appshell/cli](https://www.npmjs.com/package/@appshell/cli) package. You can simply call `appshell generate manifest --template /path/to/appshell.config.json` to produce the runtime manifest on startup.