@xswap-link/sdk 0.0.13 → 0.1.0

package/.github/workflows/main.yml

@@ -17,5 +17,5 @@ jobs:
           node-version: 16.x
           cache: "pnpm"
 
-      - run: pnpm install --frozen-lockfile
+      - run: pnpm install
       - run: pnpm run lint && pnpm run build

package/.github/workflows/publish.yml

@@ -25,7 +25,7 @@ jobs:
           node-version: 16.x
           cache: "pnpm"
 
-      - run: pnpm install --frozen-lockfile
+      - run: pnpm install
       - name: Create Release Pull Request or Publish
         id: changesets
         uses: changesets/action@v1

package/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,
+  "trailingComma": "all",
+  "singleQuote": false,
+  "semi": true
+}

package/CHANGELOG.md

@@ -1,10 +1,21 @@
 # @xswap-link/xswap-sdk
 
+## 0.1.0
+
+### Minor Changes
+
+- 59c70ca: introducing Swap & Stake modal function component
+
+### Patch Changes
+
+- a32a4d8: let disconnected users to use modal
+- d93e3aa: let integrators to provide description
+
 ## 0.0.13
 
 ### Patch Changes
 
-- f5225bc: make Route.transactions.approve optional
+- cb5f79b: add swap & stake integration
 
 ## 0.0.12
 

package/README.md

@@ -48,10 +48,7 @@ To get the library follow these simple example steps.
 
 ### Prerequisites
 
-- npm
-  ```sh
-  npm i pnpm@latest -g
-  ```
+- npm / pnpm `npm i pnpm@latest -g`
 
 ### Installation
 
@@ -59,7 +56,7 @@ Below you will find a step-by-step installation guide.
 
 1. Install the library in your project
    ```sh
-   npm i @xswap-link/xswap-sdk
+   npm/pnpm i @xswap-link/sdk
    ```
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
@@ -70,6 +67,21 @@ Below you will find a step-by-step installation guide.
 
 Simply import the stuff from the library.
 
+### Optional configuration
+
+You can create `xswap.config.local.ts` to override default configuration.
+Local file should look like this:
+
+```
+import { XSwapConfig } from "@src/models";
+
+const xSwapConfig: XSwapConfig = {
+    apiUrl: "http://127.0.0.1:5001/api",
+};
+
+export default xSwapConfig;
+```
+
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 ## Contribution
@@ -96,21 +108,18 @@ pnpm i
 #### 2. Create new branch based on the `develop` one
 
 ```sh
+git checkout develop
 git checkout -b feature/<your_feature_name>
 ```
 
-#### 3. Commit changes
+#### 3. Create changeset
 
-#### 4. Create PR to `develop` branch
+`pnpm changeset` and follow instructions to describe your changes
 
-### Publishing changes
+#### 4. Commit changes
 
-#### Create changeset file and include into PR to `main`
+including changeset: `git commit -m "feat: <your desc>>"`
 
-Github workflow will fail to publish if you skip it
-
-```sh
-pnpm changeset
-```
+#### 5. Create PR to `develop` branch
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>