readme code updates (#40)

* update code in README * chore: changeset
flashbots · Mar 20, 2024 · 755bf6c · 755bf6c
1 parent 0890d22
commit 755bf6c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/.changeset/friendly-socks-fry.md b/.changeset/friendly-socks-fry.md
@@ -0,0 +1,5 @@
+---
+"@flashbots/suave-viem": patch
+---
+
+update readme for NPM
diff --git a/src/README.md b/src/README.md
@@ -66,12 +66,15 @@
 
 ## Overview
 
+First, see these instructions for spinning up a local devnet. Then install **[@flashbots/suave-viem](https://www.npmjs.com/package/@flashbots/suave-viem)** into your project and run this code:
+
 ```ts
-import {http, Hex} from '@flashbots/suave-viem';
+import { http, type Hex } from '@flashbots/suave-viem';
+import { suaveRigil } from '@flashbots/suave-viem/chains';
 import {
   getSuaveProvider,
   getSuaveWallet,
-  TransactionRequestSuave,
+  type TransactionRequestSuave,
   SuaveTxRequestTypes
 } from '@flashbots/suave-viem/chains/utils';