search

reifyhealth / specmonstah

Specmonstah will eat the face off your test fixtures
MIT License
360 stars 18 forks source link

tutorial purpose & architecture overview #25

Closed flyingmachine closed 6 years ago

flyingmachine commented 6 years ago

hey man!!! I think this first section of the tutorial is ready :)

flyingmachine commented 6 years ago

I like your suggestions! We could update the very first section of the README, Purpose, by including additional examples of spec generation and db insertion. I didn't want the initial code snippet to include actual specs because I think they'd distract from the code we want to showcase, but we can elide those as you've suggested and put a link to the full code example.

There are definitely more ways that we can improve the README - for example I think it would be helpful to diagram the generate graph / visit ents process somehow. If you think that this PR is a step forward I think we should go ahead and merge it; unlike with code it's easy to change and we're not committing ourselves to anything that has long-term consequences (like an API), plus it's not officially released so the stakes are even lower.