Skip to content

Commit

Permalink
chore: add about section to upload-client readme & link to access docs (
Browse files Browse the repository at this point in the history
#294)

Just a small update to the upload-client readme to point users at
`w3up-client` unless they want to get into the weeds :)

Also adds a link to the access client docs in the agent creation
section.

Closes #250
  • Loading branch information
yusefnapora authored Dec 13, 2022
1 parent 93d7003 commit 595918f
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions packages/upload-client/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
<h1 align="center">⁂<br/>web3.storage</h1>
<p align="center">The upload client for <a href="https://web3.storage">https://web3.storage</a></p>

## About

The `@web3-storage/upload-client` package provides the "low level" client API for uploading data to [web3.storage](https://web3.storage) using the w3up platform.

Most users will be better served by the higher-level [`@web3-storage/w3up-client` package](https://github.com/web3-storage/w3up-client), which presents a simpler API and supports creating Agents and registering Spaces.

If you are using this package directly instead of `w3up-client`, you will also need to use the [`@web3-storage/access` client](https://github.com/web3-storage/w3protocol/tree/main/packages/access-client) for Agent and Space management.

## Install

Install the package using npm:
Expand Down Expand Up @@ -39,6 +47,8 @@ const conf = {
}
```

See the [`@web3-storage/access` docs](https://web3-storage.github.io/w3protocol/modules/_web3_storage_access.html) for more about creating and registering spaces.

### Uploading files

Once you have the `issuer`, `with` and `proofs`, you can upload a directory of files by passing that invocation config to `uploadDirectory` along with your list of files to upload.
Expand Down

0 comments on commit 595918f

Please sign in to comment.