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.

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

docs: Readme #546

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Readme #546

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8bbb14
Update README.md
Olexandr88 Nov 1, 2024
369b07b
Merge branch 'main' into patch-1
douglance Nov 25, 2024
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Arbitrum SDK

[![npm version](https://badge.fury.io/js/%40arbitrum%2Fsdk.svg)](https://badge.fury.io/js/@arbitrum%2Fsdk.svg)
[![npm version](https://badge.fury.io/js/%40arbitrum%2Fsdk.svg)](https://www.npmjs.com/package/@arbitrum/sdk)
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

A TypeScript library for client-side interactions with Arbitrum. The Arbitrum SDK provides essential helper functionality and direct access to underlying smart contract interfaces, enabling developers to build powerful applications on the Arbitrum network.
Expand Down Expand Up @@ -83,11 +83,11 @@ async function bridgeEth(parentSigner: ethers.Signer, childChainId: number) {
}
```

For more detailed usage examples and API references, please refer to the [Arbitrum SDK documentation](https://docs.arbitrum.io/sdk).
For more detailed usage examples and API references, please refer to the [Arbitrum SDK documentation](https://docs.arbitrum.io/welcome/get-started).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For more detailed usage examples and API references, please refer to the [Arbitrum SDK documentation](https://docs.arbitrum.io/welcome/get-started).
For more detailed usage examples and API references, please refer to the [Arbitrum SDK documentation](https://docs.arbitrum.io/sdk/introduction).


## Running Integration Tests

1. Set up a Nitro test node by following the instructions [here](https://docs.arbitrum.io/node-running/how-tos/local-dev-node).
1. Set up a Nitro test node by following the instructions [here](https://docs.arbitrum.io/build-decentralized-apps/public-chains#nitro).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Set up a Nitro test node by following the instructions [here](https://docs.arbitrum.io/build-decentralized-apps/public-chains#nitro).
1. Set up a Nitro test node by following the instructions [here](https://docs.arbitrum.io/run-arbitrum-node/run-nitro-dev-node).

2. Copy `.env.example` to `.env` and update relevant environment variables.
3. Generate the network configuration against your active Nitro test node:

Expand All @@ -103,7 +103,7 @@ For more detailed usage examples and API references, please refer to the [Arbitr

## Documentation

For comprehensive guides and API documentation, visit the [Arbitrum SDK Documentation](https://docs.arbitrum.io/sdk).
For comprehensive guides and API documentation, visit the [Arbitrum SDK Documentation](https://docs.arbitrum.io/welcome/get-started).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For comprehensive guides and API documentation, visit the [Arbitrum SDK Documentation](https://docs.arbitrum.io/welcome/get-started).
For comprehensive guides and API documentation, visit the [Arbitrum SDK Documentation](https://docs.arbitrum.io/sdk/introduction).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For comprehensive guides and API documentation, visit the [Arbitrum SDK Documentation](https://docs.arbitrum.io/welcome/get-started).
For comprehensive guides and API documentation, visit the [Arbitrum SDK Documentation](https://docs.arbitrum.io/sdk/introduction).


## License

Expand Down