You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The README could do with some sprucing up, a lot of content was moved into the docs and now things are looking a bit bare. I'd like the readme to give first time visitors a positive impression of the library, and an intuition as to what it does and doesn't do, within a few seconds of scrolling through.
Ideas for things to add:
A brochure style section (i.e. a clear and visual elevator pitch)
A features list
Instructions for running integration tests (in addition to the contributor.md)
Further inspiration can be found looking here readme.so
A nice header would be cool:
(@gkinsman you had some good examples of other READMEs, could you add links for reference)
The text was updated successfully, but these errors were encountered:
This issue has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
The README could do with some sprucing up, a lot of content was moved into the docs and now things are looking a bit bare. I'd like the readme to give first time visitors a positive impression of the library, and an intuition as to what it does and doesn't do, within a few seconds of scrolling through.
Ideas for things to add:
contributor.md
)Further inspiration can be found looking here readme.so
A nice header would be cool:
(@gkinsman you had some good examples of other READMEs, could you add links for reference)
The text was updated successfully, but these errors were encountered: