Skip to content

Commit

Permalink
fix(readme): update readme with default provider example
Browse files Browse the repository at this point in the history
  • Loading branch information
atticusofsparta committed Feb 15, 2024
1 parent 4b647f0 commit 68a5a16
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# node-sdk-template
# ar-io/sdk

This is the home of [INSERT SDK NAME] SDK. This SDK provides functionality for [SHORT DESCRIPTION HERE] available for both NodeJS and Web environments.
This is the home of ar.io SDK. This SDK provides functionality for interacting with the ArNS and ar.io ecosystem. It is available for both NodeJS and Web environments.

## Table of Contents

Expand All @@ -23,19 +23,24 @@ This is the home of [INSERT SDK NAME] SDK. This SDK provides functionality for [
## Installation

```shell
npm install @ardrive/INSERT-SDK-NAME
npm install @ar-io/sdk
```

or

```shell
yarn add @ardrive/INSERT-SDK-NAME
yarn add @ar-io/sdk
```

## Quick Start

```typescript
// INSERT A SHORT EXAMPLE OF HOW TO SETUP AND USE THE SDK
const remoteStateProvider = new ArNSRemoteCache();
const arIO = new ArIO({ contractStateProvider: cache });

const state = arIO.getContractState({
contractTxId: 'bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U',
});
```

## Usage
Expand Down

0 comments on commit 68a5a16

Please sign in to comment.