Skip to content

Commit

Permalink
chore(sdk-example): update readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
RanGojo committed Aug 11, 2024
1 parent a494df2 commit 89f9937
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 16 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Documents:

- [Basic-SDK Integration Tutorial](https://docs.rango.exchange/integration-quick-start/overview)
- [Basic-SDK Reference](https://docs.rango.exchange/ap-integration/basic-api-single-step/api-reference)
- [Multiple-SDK Reference](https://docs.rango.exchange/ap-integration/main-api-multi-step/api-reference)
- [Basic-SDK Integration Tutorial](https://docs.rango.exchange/api-integration/basic-api-single-step/tutorial/sdk-example)
- [Basic-SDK Reference](https://docs.rango.exchange/api-integration/basic-api-single-step/api-reference)
- [Multiple-SDK Reference](https://docs.rango.exchange/api-integration/main-api-multi-step/api-reference)

## Basic SDK (Single Step Tx)

Expand Down
16 changes: 15 additions & 1 deletion examples/basic/node-evm/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
# Node.js Example for integration Rango-SDK-Basic for EVM Transactions
## Node.js Example for integrating Rango-SDK-Basic for EVM Transactions

### Requirements:

- rango-sdk-basic
- ethers
- Node.js >= 20

### How to run the code?

```sh
cd /path/to/example/
yarn
node --import=tsx index.ts
```
8 changes: 4 additions & 4 deletions packages/rango-sdk-basic/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Rango Exchange SDK

- [Basic-SDK Integration Tutorial](https://docs.rango.exchange/integration-quick-start/overview)
- [Basic-SDK Reference](https://docs.rango.exchange/api-integration/rango-api/basic-api-single-tx)
- [Basic-SDK Integration Tutorial](https://docs.rango.exchange/api-integration/basic-api-single-step/tutorial/sdk-example)
- [Basic-SDK Reference](https://docs.rango.exchange/api-integration/basic-api-single-step/api-reference)

## Basic SDK (Single Step Tx)

Expand All @@ -20,5 +20,5 @@

Please checkout the examples' folder for sample usage of the SDK. We will add more examples there soon.

- [Documents](https://docs.rango.exchange/integration/overview)
- [Examples](https://github.com/rango-exchange/rango-sdk/tree/master/examples/basic/)
- [Documents](https://docs.rango.exchange/api-integration/basic-api-single-step/tutorial/sdk-example)
- [Examples](https://github.com/rango-exchange/rango-sdk/tree/master/examples/basic)
9 changes: 1 addition & 8 deletions packages/rango-sdk/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Rango Exchange SDK

- [Multiple-SDK Reference](https://docs.rango.exchange/api-integration/rango-api/main-api-multistep-txs)
- [Multiple-SDK Reference](https://docs.rango.exchange/api-integration/main-api-multi-step/api-reference)

## Main SDK (Multi Step Tx)

Expand All @@ -14,10 +14,3 @@
# or
npm install rango-sdk --save
```

## Usage

Please checkout the examples' folder for sample usage of the SDK. We will add more examples there soon.

- [Documents](https://docs.rango.exchange/integration/overview)
- [Examples](https://github.com/rango-exchange/rango-sdk/tree/master/examples/multi/)

0 comments on commit 89f9937

Please sign in to comment.