From 68a5a1697ae0c4c6797ef355f887408d72030cf8 Mon Sep 17 00:00:00 2001 From: atticusofsparta Date: Thu, 15 Feb 2024 15:06:27 -0600 Subject: [PATCH] fix(readme): update readme with default provider example --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f51e416e..3cb4e2ea 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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