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

Improve README #902

Open
slang25 opened this issue Apr 25, 2021 · 1 comment
Open

Improve README #902

slang25 opened this issue Apr 25, 2021 · 1 comment
Milestone

Comments

@slang25
Copy link
Member

slang25 commented Apr 25, 2021

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:
JustSaying

(@gkinsman you had some good examples of other READMEs, could you add links for reference)

@stale
Copy link

stale bot commented Apr 16, 2022

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.

@stale stale bot added the wontfix label Apr 16, 2022
@martincostello martincostello added this to the Future milestone Jul 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants