@bolt-liquidity-hq/cosmwasm-client 0.1.0-beta.4 → 0.1.0-beta.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,17 +1,24 @@
1
- # Bolt Liquidity
1
+ # CosmWasm Client for Bolt Liquidity
2
2
 
3
3
  Typescript SDK to interact with Bolt Liquidity on CosmWasm based blockchains.
4
4
 
5
5
  ## Installation
6
6
 
7
7
  ```bash
8
+ # Using npm
8
9
  npm install @bolt-liquidity-hq/cosmwasm-client
10
+
11
+ # Using yarn
12
+ yarn add @bolt-liquidity-hq/cosmwasm-client
13
+
14
+ # Using pnpm
15
+ pnpm add @bolt-liquidity-hq/cosmwasm-client
9
16
  ```
10
17
 
11
18
  ## Usage
12
19
 
13
20
  ```typescript
14
- import { BoltCosmWasmClient, Environment } from '@bolt-liquidity-hq/cosmwasm-client';
21
+ import { BoltCosmWasmClient } from '@bolt-liquidity-hq/cosmwasm-client';
15
22
 
16
23
  // Initialize client
17
24
  const client = new BoltCosmWasmClient();
@@ -32,10 +39,14 @@ const result = await client.swap(signer, {
32
39
  });
33
40
  ```
34
41
 
42
+ ## 📖 API Reference
43
+
44
+ Full API documentation is available in our [docs](https://bolt-liquidity-hq.github.io/bolt-liquidity-ts-sdk/).
45
+
35
46
  ## Development
36
47
 
37
48
  See the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
38
49
 
39
- ## License
50
+ ## 📄 License
40
51
 
41
- Apache 2.0
52
+ Apache 2.0 - see [LICENSE](../../LICENSE) for details.