search

timdeschryver / zod-fixture

Creating fixtures based on zod schemas
https://zod-fixture.timdeschryver.dev/
MIT License
122 stars 10 forks source link

Organized and Current Readme #42

Closed THEtheChad closed 1 year ago

THEtheChad commented 1 year ago

Take a looksy 👀

THEtheChad commented 1 year ago

I noticed I was struggling to keep the readme updated with the snapshots and make sure imports/syntax was correct.

In an effort to simplify the process, I stumbled across: https://github.com/zakhenry/embedme

You just put a reference to the file and lines you want to copy and run npx embedme README.md and it will automatically insert/update the code in the block. Super handy! I also refactored the examples so the "test" bits could be omitted from the readme.

We should probably add npx embedme README.md to our pipeline somewhere so the readme is always up-to-date.

github-actions[bot] commented 1 year ago

:tada: This PR is included in version 2.0.0-beta.8 :tada:

The release is available on:

Your semantic-release bot :package::rocket: