nestdotland/nest.land

No README? Then say it.

littledivy opened this issue · 6 comments

Upload a module with no README and stare 10 mins at this:
image

t8 commented

Haha fair point. This is something that should be addressed.

Proposal: eggs publish should already fail, if no README.md is included.

If you guys agree, let's move this to https://github.com/nestdotland/eggs --> I would like to try implementing this.

@michael-spengler We try as much as possible to move away from any established standard.
For example in the next version the eggs.json configuration file will no longer be mandatory.

There is already a warning in the CLI if the readme is not found. While this may seem like a critical part of any module, but I don't think a readme should be made mandatory.
Indeed, one can imagine that some authors might want to write all their documentation in the source files and use tools like deno doc to see the docs

@littledivy what module did you use, that has no readme? Gonna work on this, but I don't have anything to test with

@martonlederer Try this module https://nest.land/package/delete_me
And then we'll remove it from the gallery

Thanks