docs: update readme

storacha · Jan 23, 2024 · c86d96c · c86d96c
1 parent 794e832
commit c86d96c
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/packages/w3up-client/README.md b/packages/w3up-client/README.md
@@ -392,6 +392,7 @@ sequenceDiagram
   - [`addProof`](#addproof)
   - [`delegations`](#delegations)
   - [`createDelegation`](#createdelegation)
+  - [`remove`](#remove)
   - [`capability.access.authorize`](#capabilityaccessauthorize)
   - [`capability.access.claim`](#capabilityaccessclaim)
   - [`capability.space.info`](#capabilityspaceinfo)
@@ -592,6 +593,21 @@ function createDelegation (
 
 Create a delegation to the passed audience for the given abilities with the _current_ space as the resource.
 
+### `remove`
+
+```ts
+function remove (
+  contentCID?: CID
+  options: {
+    shards?: boolean
+  } = {}
+): Promise<Delegation>
+```
+
+Removes association of a content CID with the space. Optionally, also removes association of CAR shards with space.
+
+⚠️ Please be aware that all shards will be deleted even if there is another upload(s) that reference same shards, which in turn could corrupt those uploads.
+
 ### `getReceipt`
 
 ```ts