We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent b1f44a2 commit b7b6744Copy full SHA for b7b6744
1 file changed
README.md
@@ -135,6 +135,23 @@ console.log(
135
);
136
```
137
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
155
## Contributing
156
157
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
0 commit comments