Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: updated readme #3

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: updated readme #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions README.md
View file
Open in desktop
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
Loading