Skip to content

Commit 95a0e96

Browse files
committed
Update getting-started.md
1 parent e4037d0 commit 95a0e96

File tree

1 file changed

+10
-24
lines changed

1 file changed

+10
-24
lines changed

docs/sdk/getting-started.md

Lines changed: 10 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,56 +8,42 @@ Don't want to go through setup and build from ground up?
88

99
This template is programmed with React & Vite framework. It contains basic components ready to set you off on your cross-chain dApp journey.
1010

11-
## Install Dependencies
11+
## Install XCM SDK and its dependencies
1212

13-
Install peer dependencies according to the API package you choose.
13+
XCM SDK supports three different Javascript client providers. It is advised to use PAPI JS provider or Dedot JS provider, but in case your project heavily relies on Polkadot JS you can also install PJS SDK version.
1414

15-
ParaSpell XCM SDK is the 🥇 first in the ecosystem to support **PolkadotJS**, **Polkadot API** and **Dedot**.
1615

1716
**Choose your package manager:**
1817

1918
<PackageManagerSwitch />
2019

21-
### Polkadot API (PAPI) Peer Dependencies
20+
### Polkadot API (PAPI) version of SDK and Peer Dependencies
21+
**BEWARE: SDK uses PAPI V2 since 13.2.1 onwards!**
2222

23-
<InstallCommand pkg="polkadot-api" />
23+
24+
<InstallCommand :pkg="['@paraspell/sdk','polkadot-api']" />
2425

2526
---
2627

27-
### PolkadotJS (PJS) Peer Dependencies
28+
### PolkadotJS (PJS) version of SDK and Peer Dependencies
2829

2930
<InstallCommand :pkg="[
31+
'@paraspell/sdk-pjs',
3032
'@polkadot/api',
3133
'@polkadot/types',
3234
'@polkadot/api-base',
3335
'@polkadot/util',
3436
'@polkadot/util-crypto'
3537
]" />
3638

37-
### Dedot Peer Dependencies
39+
### Dedot version of SDK and Peer Dependencies
3840

3941
<InstallCommand :pkg="[
42+
'@paraspell/sdk-dedot',
4043
'dedot',
4144
'@polkadot/keyring',
4245
]" />
4346

44-
45-
## Install XCM SDK package
46-
XCM SDK supports three different Javascript client providers. It is advised to use PAPI JS provider or Dedot JS provider, but in case your project heavily relies on Polkadot JS you can also install PJS SDK version. Please note, that PJS and Dedot version does not have Swap functionality yet.
47-
48-
### Polkadot API (PAPI) client version
49-
**BEWARE: SDK uses PAPI V2 since 13.2.0 onwards!**
50-
51-
<InstallCommand pkg="@paraspell/sdk" />
52-
53-
### PolkadotJS (PJS) client version
54-
55-
<InstallCommand pkg="@paraspell/sdk-pjs" />
56-
57-
### Dedot client version
58-
59-
<InstallCommand pkg="@paraspell/sdk-dedot" />
60-
6147
## Install swap extension
6248
If you plan to [do Swap XCMs](https://paraspell.github.io/docs/sdk/xcmPallet.html#swap) you can install Swap package which allows you to do cross-chain swaps on popular Polkadot, Kusama, Paseo, Westend exchanges. Now available in **ALL** versions of SDK.
6349

0 commit comments

Comments
 (0)