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.

Sign up for GitHub

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

Jump to bottom

Add README to each package #219

Open
alanshaw opened this issue Feb 8, 2023 · 0 comments
Open

Add README to each package #219

alanshaw opened this issue Feb 8, 2023 · 0 comments

Comments

@alanshaw
Copy link
Member

alanshaw commented Feb 8, 2023

Each module should have a minimal README explaining what it provides and how it fits with the other modules. It should also link back to the main README for overview and usage information.

This is not good to see on npm:

Screenshot 2023-02-08 at 11 43 20
@alanshaw alanshaw changed the title Add README to each module Add README to each package Feb 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@alanshaw