# S-ONE Finance Swap Core

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

Multi-chain liquidity protocol for emerging token projects with no seed investment, founder’s fees, or pre-mining

In-depth documentation on this SDK is available at [s-one.finance](http://docs.s-one.finance/).

Feel free to read the code. More details coming soon.

## Prerequisite

To run the project, follow these steps. You must have at least node v10 and [yarn](https://yarnpkg.com/) installed.

Require [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) extension if you work on vscode studio.

```sh
code --install-extension JuanBlanco.solidity
```

VSCode is not familiar with the solidity language, so solidity support needs to be installed.

```sh
code --install-extension esbenp.prettier-vscode
```

## Running

First clone the repository:

```sh
git clone https://github.com/S-ONE-Finance/soneswap-core.git
```

Move into the soneswap-core working directory

```sh
cd soneswap-core
```

Install dependencies

```sh
yarn install
```

## Installing in another project

To install this @s-one-finance/core:

Using npm cli:

```
npm install --save @s-one-finance/core@latest
```

Using yarn cli:

```
yarn add @s-one-finance/core@latest
```
