Skip to content

Commit

Permalink
docs: Update README.md and add installation instructions for examples (
Browse files Browse the repository at this point in the history
  • Loading branch information
muddlebee authored Oct 17, 2024
1 parent 7f326b8 commit ecda631
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,21 @@ When the API is initalized using the `CDN`, `node:fetch` is being used and is st

### Example Usage

**NOTE:** For more practical usage, and specified examples please look through our `./examples` directory to see more use cases. To
run these examples: `yarn build:examples && node ./examples/build/examples/<file_to_run>.js`.
**Note:** For more detailed and practical usage examples, please refer to the `./examples` directory, where you can find various use cases. To run these examples, follow the steps below:

1. First, install the dependencies:

```bash
yarn install

```

2. Then, build and run the desired example:

```bash
yarn build:examples && node ./examples/build/examples/<file_to_run>.js
```

```typescript
import { AssetTransferApi, constructApiPromise } from '@substrate/asset-transfer-api';
Expand Down

0 comments on commit ecda631

Please sign in to comment.