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

Better post-install markdown file generation. #326

Open
davestewart opened this issue Apr 26, 2020 · 0 comments
Open

Better post-install markdown file generation. #326

davestewart opened this issue Apr 26, 2020 · 0 comments

Comments

@davestewart
Copy link

davestewart commented Apr 26, 2020

Hey,

Great lib! I've found it really useful.

The only thing I don't think works is the resulting README file.

It's quite bulky and doesn't help when you are trying to get your head around what's been generated and trying to customize and add your own code.

I would suggest modifying it so that:

It generates a new project-specific README.md file intended for the final consumer, with:

  • Project name
  • section: "Introduction"
  • section: "Importing library"
  • section: "NPM Scripts"

It contains a new tools/README.md file, intended for the package developer, with:

  • section "Features" - information about how the package works
  • section "Build" - information about Rollup, etc
  • section "Deployment" - information about releases, hooks, tools, etc
  • section "Customisation" - essentially the FAQs refactored to be a how-to on the change you want, what to update or remove, and why
  • section "Resources" useful resources

The project's main readme should just have info about the project, should only exist on GitHub for this project, and should be deleted after the install script:

  • image: Terminal
  • section "Features"
  • section "Development" link to DEVELOPMENT.md readme above
  • section "Projects"
  • section "Credits"

I may PR this.

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

1 participant