Skip to content

docs(readme): add link docs #467

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(readme): add link docs #467

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,27 @@

Learn [how to add a new chain configuration](./docs/adding-new-chain.md) to the sdks.

## Debugging

Here's a tutorial on how to link a specific package to debug at runtime:

1. From the repository in which you want to link the package: `pnpm link ../your/relative/path/to/sdks/packages/blue-sdk`

```diff
- "@morpho-org/blue-sdk": "5.0.0",
+ "@morpho-org/blue-sdk": "link:../../../sdks/packages/blue-sdk",
```

2. Modify `blue-sdk` [package.json](./packages/blue-sdk/package.json) to use js main & js files:

```diff
- "main": "src/index.ts",
+ "main": "lib/index.js",
+ "types": "lib/index.d.ts"
```

3. In a separate process, start: `pnpm --dir packages/blue-sdk build --watch`

## Authors

- [@rubilmax](https://github.com/rubilmax) (rubilmax.eth, [Twitter](https://x.com/rubilmax))
Expand Down