@xswap-link/sdk/README.md

JavaScript SDK for XSwap platform

<a name="readme-top"></a>

<!-- PROJECT LOGO -->
<br />
<div align="center">

  <h1 align="center">XSwap SDK</h1>

  <p align="center">
    XSwap SDK exposes a variety of models and tools for other projects to use.
    <br />
    <a href="https://docs.xswap.link/xswap/introduction/what-is-xswap"><strong>Explore the docs »</strong></a>
    <br />
  </p>
</div>

<!-- TABLE OF CONTENTS -->
<details>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
  </ol>
</details>

<!-- ABOUT THE PROJECT -->

## About The Project

XSwap SDK exposes a functions to access the advanced cross-chain routing solution offered by XSwap.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- GETTING STARTED -->

## Getting Started

To get the library follow these simple example steps.

### Prerequisites

- npm / pnpm `npm i pnpm@latest -g`

### Installation

Below you will find a step-by-step installation guide.

1. Install the library in your project
   ```sh
   npm/pnpm i @xswap-link/sdk
   ```

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- USAGE EXAMPLES -->

## Usage

Simply import the stuff from the library.

## Contribution

This is open-source library and below you will find a step-by-step contribution guide.

### Prerequisites

- pnpm
  ```sh
  npm i pnpm@latest -g
  ```

#### 1. Get the project and install dependencies

```sh
git clone git@github.com:xswap-link/xswap-sdk.git

cd xswap-sdk

pnpm i
```

#### 2. Create new branch based on the `develop` one

```sh
git checkout develop
git checkout -b feature/<your_feature_name>
```

#### 3. Create changeset

`pnpm changeset` and follow instructions to describe your changes

#### 4. Commit changes

including changeset: `git commit -m "feat: <your desc>>"`

#### 5. Create PR to `develop` branch

<p align="right">(<a href="#readme-top">back to top</a>)</p>