Skip to content

Commit 6e1704e

Browse files
authoredJul 6, 2024
Adds missing docs for -g flag support nearfs bundles (#124)
* adds missing doc for ipfs url * wording
1 parent a5d4bb9 commit 6e1704e

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed
 

‎README.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -229,17 +229,21 @@ Running the bos-workspace dev server will start a local gateway with a standard
229229
bw dev --no-gateway
230230
```
231231

232-
However, there is an option to override this default gateway with a custom `/dist`. This is helpful when building widgets that utilize [custom VM elements](https://github.com/NEARBuilders/near-bos-webcomponent?tab=readme-ov-file#configuring-vm-custom-elements). To use this feature, use the `-g` flag with a path to the local custom distribution:
232+
However, there is an option to override this default gateway with a custom `/dist`. This is helpful when building widgets that utilize [custom VM elements](https://github.com/NEARBuilders/near-bos-webcomponent?tab=readme-ov-file#configuring-vm-custom-elements). To use this feature, use the `-g` flag with a path to the local custom distribution or link to package published on [nearfs](https://github.com/vgrichina/nearfs) or via cdn:
233233

234234
```cmd
235235
bw dev -g path/to/dist
236236
```
237237

238-
This will automatically start the local gateway, but using the provided dist.
238+
```cmd
239+
bw dev -g https://ipfs.web4.near.page/ipfs/bafybeiancp5im5nfkdki3cfvo7ownl2knjovqh7bseegk4zvzsl4buryoi
240+
```
241+
242+
This will automatically start the local gateway serving your widgets through the provided dist.
239243

240244
It is easy to build and distribute a custom gateway using the [near-bos-webcomponent](https://github.com/nearbuilders/near-bos-webcomponent), see ["Configuring VM Custom Elements"](https://github.com/NEARBuilders/near-bos-webcomponent?tab=readme-ov-file#configuring-vm-custom-elements).
241245

242-
The bos-workspace dev server is specially configured with the near-bos-webcomponent to automatically set the `rpc` attribute with the [proxy-rpc](#proxy-rpc) when provided.
246+
The bos-workspace dev server is specially configured with the near-bos-webcomponent to automatically set the `rpc` attribute with the [proxy-rpc](#proxy-rpc).
243247

244248
## Commands
245249

@@ -285,9 +289,9 @@ bw deploy [app name] --deploy-account-id [deployAccountId] --signer-account-id [
285289

286290
* `--signer-account-id <signerAccountId>` (Optional): Account which will be used for signing deploy transactions, frequently the same as deploy-account-id. Defaults to `config.account`, or will use `config.accounts.deploy` if specified.
287291

288-
* `--signer-public-key <signerPublicKey>` (Required): Public key for signing transactions in the format: `ed25519:<public_key>`.
292+
* `--signer-public-key <signerPublicKey>` (Optional): Public key for signing transactions in the format: `ed25519:<public_key>`. Will default to interactive [near-cli-rs](https://github.com/near/near-cli-rs) if not provided.
289293

290-
* `--signer-private-key <signerPrivateKey>` (Required): Private key in `ed25519:<private_key>` format for signing transactions.
294+
* `--signer-private-key <signerPrivateKey>` (Optional): Private key in `ed25519:<private_key>` format for signing transactions. Will default to interactive [near-cli-rs](https://github.com/near/near-cli-rs) if not provided.
291295

292296
* `-n, --network <network>` (Optional): Network to deploy for (default: "mainnet").
293297

0 commit comments

Comments
 (0)
Please sign in to comment.