Skip to content

Commit

Permalink
Docs: [DX-2939] Add new README for "x-client" package (#1923)
Browse files Browse the repository at this point in the history
  • Loading branch information
zaidarain1 authored Jun 19, 2024
1 parent 7340d38 commit c64ba7b
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions packages/x-client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# X-Client

### 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-client` 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
```

Linting:

```bash
yarn lint
```

Typechecking:

```bash
yarn typecheck
```

### About

This package consists of utilities to work with the ImmutableX StarkEx-based blockchain.

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

0 comments on commit c64ba7b

Please sign in to comment.