Skip to content

Commit

Permalink
chore: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dafuga committed Jan 18, 2024
1 parent 83e9be1 commit c277e93
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,33 @@
# @wharfkit/transact-plugin-mock

A mock TransactPlugin to simulate specific event types in testing environments.
A mock TransactPlugin that can be used to simulate and test different Wharf Session Kit event types.

## Usage

TODO
Install the package:

```bash
npm install @wharfkit/transact-plugin-mock --save
# or
yarn add @wharfkit/transact-plugin-mock
```

To use this mock transact plugin, you must include it during SessionKit initialization:

```ts
import { TransactPluginMock } from '@wharfkit/transact-plugin-mock'

const sessionKit = new SessionKit(
{
// ...arguments
},
{
transactPlugins: [new TransactPluginMock()],
}
)
```

For more information on how to use Transact plugins, see the [SessionKit documentation](https://wharfkit.com/docs/session-kit/plugin-transact).

## Developing

Expand Down

0 comments on commit c277e93

Please sign in to comment.