Skip to content

Commit

Permalink
Docs: [DX-2940] Update README of "x-provider" package (#1924)
Browse files Browse the repository at this point in the history
  • Loading branch information
zaidarain1 authored Jun 20, 2024
1 parent c64ba7b commit 3df388a
Showing 1 changed file with 53 additions and 1 deletion.
54 changes: 53 additions & 1 deletion packages/x-provider/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,56 @@
# IMXProvider interface
# X-Provider

### Pre-requisites

Install dependencies for the workspace

```bash
yarn install
```

### Quick Start Guide

All commands below need to be run in the context of the `x-provider` package where this README is located. Read more about context [here](../../README.md#context).

Running in `dev` mode:

```bash
yarn dev
```

Building to `dist` directory with javascript output:

```bash
yarn build
```

Running all tests:

```bash
yarn test
```

Running changed tests in watch mode:

```bash
yarn test:watch
```

Linting:

```bash
yarn lint
```

Typechecking:

```bash
yarn typecheck
```

### About

Interface to provide methods that implement the signable actions with IMX only.
[Further reference](https://immutable.atlassian.net/wiki/spaces/PINK/pages/2107277849/Immutable+SDK+-+Draft)

[Read more about the x-provider package here](../../README.md#x-provider)

0 comments on commit 3df388a

Please sign in to comment.