permaweb-deploy 2.0.0 → 2.0.1
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 +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -28,11 +28,11 @@ To deploy your application, ensure you have a build script and a deployment scri
|
|
|
28
28
|
```json
|
|
29
29
|
"scripts": {
|
|
30
30
|
"build": "your-build-command",
|
|
31
|
-
"deploy-main": "npm run build && permaweb-deploy --
|
|
31
|
+
"deploy-main": "npm run build && permaweb-deploy --arns-name <ARNS_NAME>"
|
|
32
32
|
}
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Replace `<
|
|
35
|
+
Replace `<ARNS_NAME>` with your ArNS name.
|
|
36
36
|
|
|
37
37
|
### GitHub Actions Workflow
|
|
38
38
|
To automate the deployment, set up a GitHub Actions workflow as follows:
|
|
@@ -61,10 +61,10 @@ jobs:
|
|
|
61
61
|
### To deploy to permaweb manually via cli
|
|
62
62
|
|
|
63
63
|
```sh
|
|
64
|
-
DEPLOY_KEY=$(base64 -i wallet.json) npx permaweb-deploy --
|
|
64
|
+
DEPLOY_KEY=$(base64 -i wallet.json) npx permaweb-deploy --arns-name <ARNS_NAME>
|
|
65
65
|
```
|
|
66
66
|
|
|
67
67
|
### Important Notes
|
|
68
68
|
- **Security:** Always use a dedicated wallet for deployments to minimize risk.
|
|
69
69
|
- **Wallet Key:** The wallet must be base64 encoded to be used in the deployment script.
|
|
70
|
-
- **
|
|
70
|
+
- **ARNS Name:** The ArNS Name must be passed in so that the ANT Process can be resolved to update the target undername or root record.
|