Skip to content

Commit

Permalink
chore(docs): update README to include --ignore-engines reccomendati…
Browse files Browse the repository at this point in the history
…on for `yarn`
  • Loading branch information
dtfiedler committed Oct 8, 2024
1 parent 8a1db49 commit 22c8f08
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,12 @@ npm install @ar.io/sdk
or

```shell
yarn add @ar.io/sdk
yarn add @ar.io/sdk --ignore-engines
```

> [!Info]
> The `--ignore-engines` flag is required when using yarn, as [permaweb/aoconnect] recommends only the use of npm. Alternatively, you can add a `.yarnrc.yml` file to your project containing `ignore-engines true` to ignore the engines check.
## Quick Start

```typescript
Expand Down Expand Up @@ -1004,7 +1007,7 @@ Cancels a pending delegate withdrawal.

_Note: Requires `signer` to be provided on `IO.init` to sign the transaction._

````typescript
```typescript
const io = IO.init({ signer: new ArweaveSigner(jwk) });
const { id: txId } = await io.cancelDelegateWithdrawal(
{
Expand All @@ -1020,7 +1023,7 @@ const { id: txId } = await io.cancelDelegateWithdrawal(

### Configuration

The IO client class exposes APIs relevant to the ar.io process. It can be configured to use any AO Process ID that adheres to the [IO Network Spec]. By default, it will use the current [IO testnet process]. Refer to [AO Connect] for more information on how to configure an IO process to use specific AO infrastructure.
The IO client class exposes APIs relevant to the ar.io process. It can be configured to use any AO Process ID that adheres to the [IO Network Spec]. By default, it will use the current [IO Testnet Process]. Refer to [AO Connect] for more information on how to configure an IO process to use specific AO infrastructure.

```typescript
// provide a custom ao infrastructure and process id
Expand All @@ -1035,7 +1038,7 @@ const io = IO.init({
})
})
});
````
```

## Arweave Name Tokens (ANT's)

Expand Down Expand Up @@ -1437,14 +1440,15 @@ For more information on how to contribute, please see [CONTRIBUTING.md].
<!-- ADD ALL LINK REFERENCES BELOW -->

[ar.io]: https://ar.io
[permaweb/aoconnect]: https://github.com/permaweb/aoconnect
[package.json]: ./package.json
[examples]: ./examples
[examples/webpack]: ./examples/webpack
[examples/vite]: ./examples/vite
[CONTRIBUTING.md]: ./CONTRIBUTING.md
[AO Connect]: https://github.com/permaweb/ao/tree/main/connect
[IO testnet process]: https://www.ao.link/#/entity/agYcCFJtrMG6cqMuZfskIkFTGvUPddICmtQSBIoPdiA
[IO Network spec]: https://github.com/ar-io/ar-io-network-process?tab=readme-ov-file#contract-spec
[IO Testnet Process]: https://www.ao.link/#/entity/agYcCFJtrMG6cqMuZfskIkFTGvUPddICmtQSBIoPdiA
[IO Network Spec]: https://github.com/ar-io/ar-io-network-process?tab=readme-ov-file#contract-spec
[Winston]: https://www.npmjs.com/package/winston
[AO]: https://github.com/permaweb/ao
[ar-io-node repository]: https://github.com/ar-io/ar-io-node
Expand Down

0 comments on commit 22c8f08

Please sign in to comment.