JSMonk / hegel

An advanced static type checker
https://hegel.js.org
MIT License
2.09k stars 59 forks source link

README missing in npm tarball #245

Open Raynos opened 4 years ago

Raynos commented 4 years ago

I don't know how your publishing up to npm but I strongly recommend you update your build step to also copy the ./README.md into ./packages/core/build/README.md so that it's published with the npm tarball.

JSMonk commented 4 years ago

Oh, thank you 🙏 . I will add it soon.

Raynos commented 4 years ago

Implemented in https://github.com/JSMonk/hegel/pull/251

thecotne commented 4 years ago

@Raynos apparently i have broken your fix with this #252

i was thinking to restore your implementation but i am confused. should not readme describe package? and if so then we need seperate readme for @hegel/cli and @hegel/core

Raynos commented 4 years ago

A seperate README for @hegel/cli and @hegel/core would be good.

The same README for both is better then no readme for either.

I wanted to add a README instead of splitting the README into two README files.