fix: README for clarity #892
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
travis
approved these changes
Sep 5, 2023
| @@ -142,7 +125,7 @@ First, set the space as your "current" space using the [`setCurrentSpace` method | |||
| await client.setCurrentSpace(space.did()) | |||
| ``` | |||
|
|
|||
| Next, call the [`registerSpace` method][docs-Client#registerSpace], passing in the _same_ email address you used to authorize your agent. You | |||
| Next, call the [`registerSpace` method][docs-Client#registerSpace], passing in the email addres you want to associate with your account. You | |||
There was a problem hiding this comment.
Suggested change
| Next, call the [`registerSpace` method][docs-Client#registerSpace], passing in the email addres you want to associate with your account. You | |
| Next, call the [`registerSpace` method][docs-Client#registerSpace], passing in the email address you want to associate with your account. You |
packages/w3up-client/README.md
Outdated
|
|
||
| Calling `authorize` will cause an email to be sent to the given address. Once a user clicks the confirmation link in the email, the `authorize` method will resolve. Make sure to check for errors, as `authorize` will fail if the email is not confirmed within the expiration timeout. | ||
|
|
||
| If this is not the first time you authorized an agent with your email, then you'll want to claim any spaces and delegations you have on your other agent(s): |
There was a problem hiding this comment.
fwiw this will be run automatically when they call client.authorize - no need to call it separately
There was a problem hiding this comment.
just clarifying, claim is only useful if your agent is already authorized but there's a new space? (this was leftover from the README before)
There was a problem hiding this comment.
yea I think that's right - if another agent creates a space and registers it to your account, and you've already authorized, you'd probably want to claim() - can't think of other situations where you'd use that currently
Co-authored-by: Travis Vachon <travis.vachon@protocol.ai>
alanshaw
pushed a commit
that referenced
this pull request
Sep 7, 2023
🤖 I have created a release *beep* *boop* --- ## [8.0.2](w3up-client-v8.0.1...w3up-client-v8.0.2) (2023-09-07) ### Bug Fixes * node version ([#907](#907)) ([366a940](366a940)) * README for clarity ([#892](#892)) ([2e75726](2e75726)) * types for capability specific clients ([#904](#904)) ([b69d4aa](b69d4aa)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: Alan Shaw <alan.shaw@protocol.ai>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.