ethereumjs / ethereumjs-monorepo

Monorepo for the Ethereum VM TypeScript Implementation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Monorepo examples rewrite

acolytec3 opened this issue · comments

The work of rewriting our code examples in the various READMEs as actual scripts that are accurate that then get embedded into the readmes using embedme was begun with #3226 and #3228 but should be finished up. Below is the list of what's been done and what's left to be finished.

For each package, we need to add a new script to package.json for "examples:build": "npx embedme README.md", and then update all the code blocks in the main README.md for that package to use embedme. Reference previous PRs for ways that we've modified/updated examples to reflect actual usage.