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

Support README.txt and README.rst etc #421

Closed
fitzgen opened this issue Oct 29, 2018 · 2 comments
Closed

Support README.txt and README.rst etc #421

fitzgen opened this issue Oct 29, 2018 · 2 comments
Labels
question Further information is requested

Comments

@fitzgen
Copy link
Member

fitzgen commented Oct 29, 2018

💡 Feature description

Add support for various kinds of README files, not hard-coding only README.md. Right now we will only copy README.md into the package, not any other kind of README file. We can iterate over the files in the crate directory, find all files whose name (without extension) is "README" and copy those over.

💻 Basic example

  • README.rst -- restructured text
  • README.txt -- plain text
  • README.html -- html
  • README -- plain text with no extension
  • etc...
@fitzgen fitzgen added bug Something isn't working enhancement New feature or request labels Oct 29, 2018
@ashleygwilliams
Copy link
Member

Are we sure we want to do this? npm doesn't support these so I'm not sure it makes sense for us to support them.

@ashleygwilliams ashleygwilliams added question Further information is requested and removed bug Something isn't working enhancement New feature or request labels Nov 9, 2018
@ashleygwilliams
Copy link
Member

i think we have decided we are only going to support README.md for now. willing to revisit later.

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

No branches or pull requests

2 participants