Skip to content

Commit b7b6744

Browse files
committed
docs: document rekey feature
1 parent b1f44a2 commit b7b6744

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,23 @@ console.log(
135135
);
136136
```
137137

138+
## API Reference
139+
140+
### Session
141+
142+
| Member | Description |
143+
|--------|-------------|
144+
| `secretKey` | The account's secret key |
145+
| `vaults` | List of unlocked vaults |
146+
| `getPersonalVault()` | Convenience method to get the primary vault |
147+
| `rekey(emailAddress, password)` | Change account credentials by re-encrypting the master keyset |
148+
149+
### AuthenticationFlow
150+
151+
| Method | Description |
152+
|--------|-------------|
153+
| `login(emailAddress, password, secretKey)` | Authenticate and unlock vaults |
154+
138155
## Contributing
139156

140157
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

0 commit comments

Comments
 (0)