@paraspell/sdk 6.2.3 → 7.0.0

package/README.md

@@ -26,31 +26,57 @@
 <br /><br />
 ## Installation
 
-#### Install dependencies
+### Install dependencies
+
+Install peer dependencies according to the choice of API package. 
+
+ParaSpell XCM SDK is the 🥇 in the ecosystem to support both **PolkadotJS** and **PolkadotAPI**.
+
+```
+NOTE: Make sure to set PeerDependencyInstall flag to false on your package manager (Because it will install both API packages instead of just one)
+For example on PNPM: `pnpm config set auto-install-peers false`
+```
 
 ```bash
+#NOTE: apps-config will soon be removed entirely from the peer dependency list
+
+#Choose a package and install its dependencies below (SDK is built in a way, that only one library has to be installed)
+
+#Polkadot API peer dependencies
+pnpm | npm install || yarn add polkadot-api @polkadot/apps-config
+
+#PolkadotJS peer dependencies
 pnpm | npm install || yarn add @polkadot/api @polkadot/types @polkadot/api-base @polkadot/apps-config @polkadot/util
 ```
 
-#### Install SDK 
+### Install SDK 
 
 ```bash
 pnpm | npm install || yarn add @paraspell/sdk
 ```
 
-#### Importing package to your project:
+### Importing package to your project
 
 Builder pattern:
 ```js
+// Polkadot API version
+import { Builder } from '@paraspell/sdk/papi'
+
+// Polkadot JS version
 import { Builder } from '@paraspell/sdk'
 ```
 
 Other patterns:
 ```js
-// ESM
+// ESM PAPI
+import * as paraspell from '@paraspell/sdk/papi'
+// ESM PJS
 import * as paraspell from '@paraspell/sdk'
 
-// CommonJS
+// CommonJS PAPI
+const paraspell = require('@paraspell/sdk/papi')
+
+// CommonJS PJS
 const paraspell = require('@paraspell/sdk')
 ```
 
@@ -263,7 +289,10 @@ paraspell.NODE_NAMES
 
 ### Parachain XCM Pallet queries
 ```ts
+//PJS
 import { getDefaultPallet, getSupportedPallets, SUPPORTED_PALLETS } from  '@paraspell/sdk'
+//PAPI
+import { getDefaultPallet, getSupportedPallets, SUPPORTED_PALLETS } from  '@paraspell/sdk/papi'
 
 //Retrieve default pallet for specific Parachain 
 getDefaultPallet(node: TNode)
@@ -277,14 +306,20 @@ console.log(SUPPORTED_PALLETS)
 
 ### Existential deposit queries
 ```ts
+//PJS
 import { getExistentialDeposit } from "@paraspell/sdk";
+//PAPI
+import { getExistentialDeposit } from "@paraspell/sdk/papi";
 
 const ed = getExistentialDeposit('Acala')
 ```
 
 ### XCM Transfer info
 ```ts
-import { getTransferInfo, getBalanceForeign, getBalanceNative, getOriginFeeDetails } from "@paraspell/sdk"; 
+//PJS
+import { getTransferInfo, getBalanceForeign, getBalanceNative, getOriginFeeDetails } from "@paraspell/sdk";
+//PAPI
+import { getTransferInfo, getBalanceForeign, getBalanceNative, getOriginFeeDetails } from "@paraspell/sdk/papi"; 
 
 //Get balance of foreign currency
 await getBalanceForeign(address, Parachain name, currency /*- {id: currencyID} | {symbol: currencySymbol}*/)