publish-microfrontend 0.15.6-beta.5103 → 0.15.6-beta.5105

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.
package/README.md CHANGED
@@ -4,6 +4,28 @@
4
4
 
5
5
  A simple command-line utility for publishing micro frontends to compatible feed services.
6
6
 
7
+ ## Usage
8
+
9
+ You can publish any micro frontend using this tool using
10
+
11
+ ```sh
12
+ npx publish-microfrontend --url <feed-url> --api-key <feed-api-key>
13
+ ```
14
+
15
+ By default, this will take the current folder, pack it, and push it to a server. This server could also be configured in a `.microfrontendrc` file such as
16
+
17
+ ```json
18
+ {
19
+ "url": "https://myfeed.com/api/v1/pilet"
20
+ }
21
+ ```
22
+
23
+ No API key is necessary. Depending on your feed server you might want to use interactive authentication:
24
+
25
+ ```sh
26
+ npx publish-microfrontend --url <feed-url> --interactive
27
+ ```
28
+
7
29
  ## License
8
30
 
9
31
  Piral is released using the MIT license. For more information see the [license file](./LICENSE).