From c277e93d2c3cfd7197d913e79e0aea032ecdccd4 Mon Sep 17 00:00:00 2001
From: dafuga <danielfugere28@gmail.com>
Date: Thu, 18 Jan 2024 15:57:09 -0800
Subject: [PATCH] chore: updated readme

---
 README.md | 27 +++++++++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 93ed893..6bb9f17 100644
--- a/README.md
+++ b/README.md
@@ -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