-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add add-to-web3 to the main readme (#1267)
Add a section about https://github.com/web3-storage/add-to-web3 to the main readme for discovery. License: MIT --------- Signed-off-by: Oli Evans <[email protected]>
- Loading branch information
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -65,6 +65,28 @@ See https://web3.storage/docs/w3up-client for a guide to using the js client for | |
|
||
For an interactive command line adventure into the using w3up check out `learnyouw3up` here https://github.com/web3-storage/learnyouw3up | ||
|
||
### GitHub Action | ||
|
||
The Action [`add-to-web3`](https://github.com/marketplace/actions/add-to-web3) wraps [`w3cli`](https://github.com/web3-storage/w3cli) to let you add files to web3.storage from your GitHub Workflows. | ||
|
||
**github-workflow.yaml** | ||
```yaml | ||
- run: npm run build # e.g output your static site to `./dist` | ||
|
||
- uses: web3-storage/[email protected] | ||
id: w3up | ||
with: | ||
path_to_add: 'dist' | ||
secret_key: ${{ secrets.W3_PRINCIPAL }} | ||
proof: ${{ secrets.W3_PROOF }} | ||
|
||
- run: echo ${{ steps.w3up.outputs.cid }} | ||
# "bafkreicysg23kiwv34eg2d7qweipxwosdo2py4ldv42nbauguluen5v6am" | ||
- run: echo ${{ steps.w3up.outputs.url }} | ||
# "https://dweb.link/ipfs/bafkreicysg23kiwv34eg2d7qweipxwosdo2py4ldv42nbauguluen5v6am" | ||
``` | ||
|
||
To generate a `secret_key` and delegate permissions to it as a `proof` to use in CI see: https://github.com/web3-storage/add-to-web3#generating-a-secret_key-and-proof | ||
|
||
## Contributing | ||
|
||
|