Merge pull request #8 from lidofinance/fix/update_version_and_readme

Fix/update version and readme
lidofinance · Aug 24, 2023 · cb16d9d · cb16d9d
2 parents 8d8c086 + 753f57c
commit cb16d9d
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/packages/sdk/README.md b/packages/sdk/README.md
@@ -6,17 +6,25 @@
 
 You can install the Lido Ethereum SDK using npm or yarn:
 
+yarn:
+
 ```bash
 yarn add @lidofinance/lido-ethereum-sdk
 ```
 
+npm:
+
+```bash
+npm install @lidofinance/lido-ethereum-sdk
+```
+
 ## Modules
 
 The Lido Ethereum SDK consists of several modules:
 
 - **Core** - provides access to the SDK core functionality
 - **Staking** - provides access to the Lido staking functionality
-  ...
+  TODO: add more modules
 
 ## Usage
 
@@ -74,6 +82,8 @@ const lidoSDK = new LidoSDK({
 
 // Views
 const balanceETH = await lidoSDK.core.balanceETH(address);
+
+console.log(balanceETH.toString(), "ETH balance");
 ```
 
 ### Staking
@@ -98,7 +108,6 @@ const stakeResult = await lidoSDK.staking.stake({
   referralAddress,
 });
 
-console.log(balanceETH.toString(), "ETH balance");
 console.log(balanceStETH.toString(), "stETH balance");
 console.log(addressStETH, "stETH contract address");
 console.log(contractStETH, "stETH contract");

diff --git a/packages/sdk/src/core/core.ts b/packages/sdk/src/core/core.ts
@@ -28,6 +28,7 @@ import {
   Cache,
 } from "../common/decorators/index.js";
 import { SUPPORTED_CHAINS } from "../common/constants.js";
+
 import { LidoSDKCoreProps } from "./types.js";
 
 export default class LidoSDKCore {

diff --git a/packages/sdk/src/version.ts b/packages/sdk/src/version.ts
@@ -1 +1 @@
-export const version = "1";
+export const version = "version_replace";