update compat readme to include instructions (#57)

* docs: readme * Update packages/compat/README.md Co-authored-by: Callum McIntyre <[email protected]> --------- Co-authored-by: Callum McIntyre <[email protected]>
anza-xyz · Jan 13, 2025 · 9029dc1 · 9029dc1
1 parent 1e47a5e
commit 9029dc1
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/.changeset/rotten-dryers-fix.md b/.changeset/rotten-dryers-fix.md
@@ -0,0 +1,5 @@
+---
+'@solana/compat': patch
+---
+
+updated readme to include instruction compat functions
diff --git a/packages/compat/README.md b/packages/compat/README.md
@@ -33,7 +33,7 @@ import { fromLegacyKeypair } from '@solana/compat';
 const { privateKey, publicKey } = await fromLegacyKeypair(Keypair.generate());
 ```
 
-### `fromVersionedTransaction`
+### `fromVersionedTransaction()`
 
 This can be used to convert a legacy `VersionedTransaction` object to a `Transaction` object.
 
@@ -44,3 +44,15 @@ import { fromVersionedTransaction } from '@solana/compat';
 const legacyVersionedTransaction = getMyLegacyVersionedTransaction();
 const transaction = fromVersionedTransaction(legacyVersionedTransaction);
 ```
+
+### `fromLegacyTransactionInstruction()`
+
+This can be used to convert a legacy `TransactionInstruction` object to a `IInstruction` object.
+
+```ts
+import { fromLegacyTransactionInstruction } from '@solana/compat';
+
+// imagine a function that returns a legacy `TransactionInstruction`
+const legacyInstruction = getMyLegacyInstruction();
+const instruction = fromLegacyTransactionInstruction(legacyInstruction);
+```