update compat readme to include instructions

[nickfrosty]

Overview

The readme for the @solana/compat is missing documentation for the instruction related compat functions

Changes

• added fromLegacyTransactionInstruction to readme
• updated headings to be consistent

Fixes: #56

[changeset-bot]

🦋 Changeset detected

Latest commit: 3b992b7

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[bundlemon]

BundleMon

Unchanged files (127)

Status	Path	Size	Limits
✅	@solana/web3.js production bundle library/dist/index.production.min.js	33.81KB	-
✅	rpc-graphql/dist/index.browser.mjs	18.76KB	-
✅	rpc-graphql/dist/index.native.mjs	18.75KB	-
✅	rpc-graphql/dist/index.node.mjs	18.75KB	-
✅	errors/dist/index.node.mjs	14.06KB	-
✅	errors/dist/index.browser.mjs	14.04KB	-
✅	errors/dist/index.native.mjs	14.03KB	-
✅	transaction-messages/dist/index.browser.mjs	7.05KB	-
✅	transaction-messages/dist/index.native.mjs	7.05KB	-
✅	transaction-messages/dist/index.node.mjs	7.05KB	-
✅	codecs-data-structures/dist/index.native.mjs	4.77KB	-
✅	codecs-data-structures/dist/index.browser.mjs	4.77KB	-
✅	codecs-data-structures/dist/index.node.mjs	4.77KB	-
✅	webcrypto-ed25519-polyfill/dist/index.node.mj s	3.49KB	-
✅	webcrypto-ed25519-polyfill/dist/index.browser .mjs	3.47KB	-
✅	webcrypto-ed25519-polyfill/dist/index.native. mjs	3.45KB	-
✅	rpc-subscriptions/dist/index.browser.mjs	3.38KB	-
✅	rpc-subscriptions/dist/index.node.mjs	3.34KB	-
✅	rpc-subscriptions/dist/index.native.mjs	3.31KB	-
✅	codecs-core/dist/index.browser.mjs	3.3KB	-
✅	codecs-core/dist/index.native.mjs	3.3KB	-
✅	codecs-core/dist/index.node.mjs	3.3KB	-
✅	rpc-transformers/dist/index.browser.mjs	2.92KB	-
✅	rpc-transformers/dist/index.native.mjs	2.92KB	-
✅	rpc-transformers/dist/index.node.mjs	2.92KB	-
✅	addresses/dist/index.browser.mjs	2.8KB	-
✅	addresses/dist/index.native.mjs	2.8KB	-
✅	addresses/dist/index.node.mjs	2.8KB	-
✅	library/dist/index.browser.mjs	2.67KB	-
✅	library/dist/index.native.mjs	2.67KB	-
✅	library/dist/index.node.mjs	2.67KB	-
✅	codecs-strings/dist/index.browser.mjs	2.53KB	-
✅	signers/dist/index.browser.mjs	2.53KB	-
✅	signers/dist/index.native.mjs	2.53KB	-
✅	signers/dist/index.node.mjs	2.53KB	-
✅	codecs-strings/dist/index.node.mjs	2.48KB	-
✅	codecs-strings/dist/index.native.mjs	2.46KB	-
✅	transaction-confirmation/dist/index.node.mjs	2.4KB	-
✅	transaction-confirmation/dist/index.native.mj s	2.34KB	-
✅	transaction-confirmation/dist/index.browser.m js	2.34KB	-
✅	sysvars/dist/index.browser.mjs	2.25KB	-
✅	sysvars/dist/index.native.mjs	2.25KB	-
✅	sysvars/dist/index.node.mjs	2.24KB	-
✅	rpc-subscriptions-spec/dist/index.node.mjs	2.13KB	-
✅	rpc-subscriptions-spec/dist/index.native.mjs	2.08KB	-
✅	rpc-subscriptions-spec/dist/index.browser.mjs	2.08KB	-
✅	codecs-numbers/dist/index.native.mjs	2.01KB	-
✅	codecs-numbers/dist/index.browser.mjs	2.01KB	-
✅	codecs-numbers/dist/index.node.mjs	2.01KB	-
✅	transactions/dist/index.browser.mjs	1.99KB	-
✅	react/dist/index.native.mjs	1.99KB	-
✅	transactions/dist/index.native.mjs	1.99KB	-
✅	react/dist/index.browser.mjs	1.99KB	-
✅	react/dist/index.node.mjs	1.99KB	-
✅	transactions/dist/index.node.mjs	1.99KB	-
✅	rpc/dist/index.node.mjs	1.95KB	-
✅	rpc-transport-http/dist/index.browser.mjs	1.91KB	-
✅	rpc-transport-http/dist/index.native.mjs	1.91KB	-
✅	keys/dist/index.browser.mjs	1.86KB	-
✅	keys/dist/index.native.mjs	1.86KB	-
✅	keys/dist/index.node.mjs	1.85KB	-
✅	rpc/dist/index.native.mjs	1.8KB	-
✅	subscribable/dist/index.node.mjs	1.8KB	-
✅	rpc/dist/index.browser.mjs	1.8KB	-
✅	rpc-transport-http/dist/index.node.mjs	1.75KB	-
✅	subscribable/dist/index.native.mjs	1.75KB	-
✅	subscribable/dist/index.browser.mjs	1.74KB	-
✅	rpc-types/dist/index.browser.mjs	1.6KB	-
✅	rpc-types/dist/index.native.mjs	1.6KB	-
✅	rpc-types/dist/index.node.mjs	1.6KB	-
✅	rpc-subscriptions-channel-websocket/dist/inde x.node.mjs	1.33KB	-
✅	rpc-subscriptions-channel-websocket/dist/inde x.native.mjs	1.27KB	-
✅	rpc-subscriptions-channel-websocket/dist/inde x.browser.mjs	1.26KB	-
✅	options/dist/index.browser.mjs	1.18KB	-
✅	options/dist/index.native.mjs	1.18KB	-
✅	options/dist/index.node.mjs	1.17KB	-
✅	accounts/dist/index.browser.mjs	1.13KB	-
✅	accounts/dist/index.native.mjs	1.12KB	-
✅	accounts/dist/index.node.mjs	1.12KB	-
✅	compat/dist/index.browser.mjs	971B	-
✅	compat/dist/index.native.mjs	970B	-
✅	compat/dist/index.node.mjs	968B	-
✅	rpc-spec-types/dist/index.browser.mjs	964B	-
✅	rpc-api/dist/index.browser.mjs	963B	-
✅	rpc-api/dist/index.native.mjs	962B	-
✅	rpc-spec-types/dist/index.native.mjs	962B	-
✅	rpc-spec-types/dist/index.node.mjs	961B	-
✅	rpc-api/dist/index.node.mjs	960B	-
✅	rpc-subscriptions-api/dist/index.native.mjs	870B	-
✅	rpc-subscriptions-api/dist/index.node.mjs	869B	-
✅	rpc-subscriptions-api/dist/index.browser.mjs	868B	-
✅	rpc-spec/dist/index.browser.mjs	829B	-
✅	rpc-spec/dist/index.native.mjs	829B	-
✅	rpc-spec/dist/index.node.mjs	828B	-
✅	promises/dist/index.browser.mjs	799B	-
✅	promises/dist/index.native.mjs	798B	-
✅	promises/dist/index.node.mjs	797B	-
✅	assertions/dist/index.browser.mjs	790B	-
✅	instructions/dist/index.browser.mjs	771B	-
✅	instructions/dist/index.native.mjs	770B	-
✅	instructions/dist/index.node.mjs	768B	-
✅	assertions/dist/index.native.mjs	724B	-
✅	fast-stable-stringify/dist/index.browser.mjs	724B	-
✅	assertions/dist/index.node.mjs	723B	-
✅	fast-stable-stringify/dist/index.native.mjs	723B	-
✅	fast-stable-stringify/dist/index.node.mjs	722B	-
✅	programs/dist/index.browser.mjs	329B	-
✅	programs/dist/index.native.mjs	327B	-
✅	programs/dist/index.node.mjs	325B	-
✅	event-target-impl/dist/index.node.mjs	233B	-
✅	functional/dist/index.browser.mjs	154B	-
✅	functional/dist/index.native.mjs	152B	-
✅	text-encoding-impl/dist/index.native.mjs	152B	-
✅	functional/dist/index.node.mjs	151B	-
✅	codecs/dist/index.browser.mjs	137B	-
✅	codecs/dist/index.native.mjs	136B	-
✅	codecs/dist/index.node.mjs	134B	-
✅	event-target-impl/dist/index.browser.mjs	133B	-
✅	ws-impl/dist/index.node.mjs	131B	-
✅	text-encoding-impl/dist/index.browser.mjs	122B	-
✅	text-encoding-impl/dist/index.node.mjs	119B	-
✅	crypto-impl/dist/index.node.mjs	114B	-
✅	ws-impl/dist/index.browser.mjs	113B	-
✅	crypto-impl/dist/index.browser.mjs	109B	-
✅	rpc-parsed-types/dist/index.browser.mjs	66B	-
✅	rpc-parsed-types/dist/index.native.mjs	65B	-
✅	rpc-parsed-types/dist/index.node.mjs	63B	-

No change in files bundle size

Final result: ✅

View report in BundleMon website ➡️

---

Current branch size history | Target branch size history

[mcintyre94]

Thanks! Just need to update these variable names and this is good

[github-actions]

Because there has been no activity on this PR for 14 days since it was merged, it has been automatically locked. Please open a new issue if it requires a follow up.