We already have a README.md at the root of the mcmc-monitor repo. However, the readme for the npm package will need to be in the service/ foder, and needs to be copied to dist/ during the build step. I don't think this should be the same readme as in the repo. It should be abbreviated... just give a quick summary of what it does, and then provide a link to the docs which is the readme of the repo.
This page has a blank README:
https://www.npmjs.com/package/mcmc-monitor
We already have a README.md at the root of the mcmc-monitor repo. However, the readme for the npm package will need to be in the service/ foder, and needs to be copied to dist/ during the build step. I don't think this should be the same readme as in the repo. It should be abbreviated... just give a quick summary of what it does, and then provide a link to the docs which is the readme of the repo.