Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
olizilla authored Jul 26, 2021
1 parent b9976b0 commit 863f23f
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,25 @@ with:

**Required** API token for web3.storage

### `web3_api`

_Default_ `https://api.web3.storage`
<details>
<summary>Show advanced input options</summary>


**Required** API URL for web3.storage
### `web3_api`

Useful for testing against dev deployments.

_Default_ `https://api.web3.storage`

### `wrap_with_directory`

Should the `path_to_add` be wrapped in a diretory when creating the IPFS DAG. For most folks using this, the default of `false` is fine. If you want to add a single file and preserve the filename in the IPFS DAG you may want to set it to `true`.'

_Default_ `false`

**Required** Should the `path_to_add` be wrapped in a diretory when creating the IPFS DAG. For most folks using this, the default of `false` is fine. If you want to add a single file and preserve the filename in the IPFS DAG you may want to set it to `true`.'

</details>

## Outputs

Expand All @@ -60,4 +68,4 @@ e.g. `https://dweb.link/ipfs/bafkreicysg23kiwv34eg2d7qweipxwosdo2py4ldv42nbaugul

The `dist` folder is commited to the repo as is the curious cultural norm with JS actions, as the repo is the delivery mechanism, so to spare some cycles for the user users, all the deps are bundled into a single /dist/index.js monolith. This no longer makes much sense as we're also wrapping it in a container, but the dream is that the new node16 runner lands, and we can just delete the Dockers and move on.

<h3 align="center"><a href="https://web3.storage">⁂</a></h3>
<h3 align="center"><a href="https://web3.storage">⁂</a></h3>

0 comments on commit 863f23f

Please sign in to comment.