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

Add README for each package. #398

Open
krisselden opened this issue Jan 21, 2017 · 5 comments · May be fixed by #1077
Open

Add README for each package. #398

krisselden opened this issue Jan 21, 2017 · 5 comments · May be fixed by #1077

Comments

@krisselden
Copy link
Contributor

No description provided.

@locks
Copy link
Contributor

locks commented Jan 21, 2017

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

@rwjblue
Copy link
Member

rwjblue commented Jan 21, 2017

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.

@rajasegar
Copy link

rajasegar commented Apr 20, 2020

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

@locks
Copy link
Contributor

locks commented Apr 20, 2020

Done!

@locks
Copy link
Contributor

locks commented Apr 20, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants