glimmer-vm icon indicating copy to clipboard operation
glimmer-vm copied to clipboard

Add README for each package.

Open krisselden opened this issue 8 years ago • 5 comments

krisselden avatar Jan 21 '17 00:01 krisselden

@krisselden any specific information you want, or just the generic NPM readme with the package details?

locks avatar Jan 21 '17 01:01 locks

Ideally we say what the conceptual point of the package is. Possibly even an arch diagram.

Since we are publishing them all separately, this README is also displayed when the package is viewed in NPM.

rwjblue avatar Jan 21 '17 04:01 rwjblue

@locks I can pick this one, though I need some help, can you please assign it to me?

rajasegar avatar Apr 20 '20 07:04 rajasegar

Done!

locks avatar Apr 20 '20 11:04 locks

I think the first step here is to submit a PR with a proposal for the boilerplate README that we can add to all of the packages. After we decide on that we can create all of the READMEs and then fill them out with details as we go along.

locks avatar Apr 20 '20 11:04 locks