README not copied when using --template

[craigsdennis]

The README from the function template does not get copied across during initialization from a template.

It would be ideal to be able to use README's for functions that require additional setup/instructions.

Definitely open to other ways of providing setup instruction as well.

[welcome]

Thank you so much for opening your first issue in this project! We'll try to get back to it as quickly as possible. While you are waiting...here's a random picture of a corgi (powered by dog.ceo)

[philnash]

This is a good idea, but the thing that bugs me about it is where to put downloaded READMEs. Function templates are run both in new and existing projects and can even add to the existing sub directories.

So, proposal:

We include a readmes/instructions directory and download the template's README to readmes/${templateName}.md. The only reason to not download a README is if readmes/${templateName}.md already exists and this is presumably because you liked the template so much you downloaded it again.

Finally, we log to the console that instructions for the function you just initialized are available in readmes/${templateName}.md.

What do you think?

[dkundel]

I think that's a great solution for this

[craigsdennis]

Sounds great! 👍