Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix a few mistakes in the README file #103

Merged
merged 3 commits into from
Nov 29, 2023

Conversation

pheuberger
Copy link
Contributor

@pheuberger pheuberger commented Nov 29, 2023

The docs showed that ToucanClient is a named export which it isn't.
It's a default export, thus the correct way to import the libary is like so:

import ToucanClient from 'toucan-sdk';

Please review the .gitignore change #102 before this one.

I added another commit because it was also pertaining to the docs but the branch name is a bit out of date now.

Some vim plugins like Gutentags
(https://github.com/ludovicchabant/vim-gutentags) write `tags` files
into the project directory to keep track of symbols.

This file needs to be ignored by git because it should never be
committed.
The docs showed that `ToucanClient` is a named export which it isn't.
It's a default export, thus the correct way to import the libary is like
so:

```
import ToucanClient from 'toucan-sdk'
```
Since different users were introduced in commit #51901639 the comment
below the code example was out of date. This also meant that the signer
address is not the beneficiary address as it's now two different
entities.
@pheuberger pheuberger changed the title Fix import in docs Fix a few mistakes in the docs Nov 29, 2023
@pheuberger pheuberger changed the title Fix a few mistakes in the docs Fix a few mistakes in the README file Nov 29, 2023
@pheuberger pheuberger merged commit ed806d1 into ToucanProtocol:main Nov 29, 2023
1 check passed
@pheuberger pheuberger deleted the fix-import-in-docs branch November 29, 2023 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants