Skip to content

Commit

Permalink
docs(): update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric Jiang committed Jan 9, 2019
1 parent baf4283 commit b46e560
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,13 +163,14 @@ Upgrades a proxy to another `AFS` standard.
- `opts`
- `contentDid` - The `DID` of the content
- `password` - The password of the owner of the proxy
- `afsPassword` - The password of the AFS
- `version` - The `AFS` standard version to upgrade to
- `keyringOpts` - optional Keyring options

Returns a `boolean` indicating whether the proxy was successfully upgraded.

```js
const upgraded = await registry.upgradeProxy({ contentDid, password, version: '1' })
const upgraded = await registry.upgradeProxy({ contentDid, password, afsPassword, version: '1' })
```

<a name="deploy"></a>
Expand All @@ -180,6 +181,7 @@ Deploys a proxy to an `AFS` standard.
- `opts`
- `contentDid` - The `DID` of the content to deploy a proxy for
- `password` - The password of the owner of the `AFS`
- `afsPassword` - The password of the AFS
- `version` - The version to use with this proxy
- `estimate` - optional Flag to check cost of `deployProxy`
- `keyringOpts` - optional Keyring options
Expand All @@ -188,7 +190,7 @@ Deploys a proxy to an `AFS` standard.
Returns the address at which the proxy was deployed.

```js
const address = await registry.deployProxy({ contentDid, password, version: '1' })
const address = await registry.deployProxy({ contentDid, password, afsPassword, version: '1' })
```

<a name="proxyversion"></a>
Expand Down Expand Up @@ -696,6 +698,7 @@ Approves an AFS ownership transfer request.
- `opts`
- `contentDid` - The `DID` of the content to transfer ownership
- `password` - The password of the current owner
- `afsPassword` - The password of the AFS
- `newOwnerDid` - The `DID` of the account to transfer ownership to
- `estimate` - optional Flag to check cost of `approveOwnershipTransfer`

Expand All @@ -705,6 +708,7 @@ Returns transaction `receipt` object.
const receipt = await ownership.approveOwnershipTransfer({
contentDid,
password,
afsPassword,
newOwnerDid
})
```
Expand Down

0 comments on commit b46e560

Please sign in to comment.