Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make readme checking case- and extension-insensitive #323

Open
nnmrts opened this issue Nov 7, 2021 · 1 comment
Open

Make readme checking case- and extension-insensitive #323

nnmrts opened this issue Nov 7, 2021 · 1 comment

Comments

@nnmrts
Copy link

nnmrts commented Nov 7, 2021

Is your feature request related to a problem? If so, please describe.
My (and many other projects) don't have a readme file in their repo that's exactly called README.md. Currently the readme filename has to be exactly this, otherwise the module page will say "No README found for this module". A lot of projects have a readme.txt or README.txt, or just README. I've also seen readme.md a lot and use it myself.

Describe the solution you'd like
Just relax the readme check a bit. GitHub for example accepts the above mentioned variations as well.

Describe alternatives you've considered
A config field in egg.json, like readme, where one could set this to a relative path. Personally I would prefer nest.land doing it automatically though.

@nnmrts nnmrts changed the title Make readme checking case and extension-insensitive Make readme checking case- and extension-insensitive Nov 7, 2021
@UltiRequiem
Copy link

Please!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants