Skip to content

Commit

Permalink
Docs: [DX-2933] Update README of "webhook" package (#1920)
Browse files Browse the repository at this point in the history
  • Loading branch information
zaidarain1 authored Jun 19, 2024
1 parent d0ef575 commit 798dc2c
Showing 1 changed file with 47 additions and 1 deletion.
48 changes: 47 additions & 1 deletion packages/webhook/sdk/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,49 @@
# Webhook

This package consists of utility to work with [Immutable webhooks](https://docs.immutable.com/docs/zkEVM/products/blockchain-data/webhooks)
### 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 `webhook` 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 [Immutable webhooks](https://docs.immutable.com/docs/zkEVM/products/blockchain-data/webhooks)

[Read more about the webhook package here](../../../README.md#webhook)

0 comments on commit 798dc2c

Please sign in to comment.