Skip to content
This repository has been archived by the owner on Aug 28, 2023. It is now read-only.

Readme needs some LUV #2

Open
gnunicorn opened this issue Sep 16, 2019 · 3 comments
Open

Readme needs some LUV #2

gnunicorn opened this issue Sep 16, 2019 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed
Milestone
1.0

Comments

@gnunicorn
Copy link
Owner

The readme is very short and barebone at the moment. It should be expanded and explain in more detail. I see the following sections as useful:

  • Screenshot / example code and example rendering
  • cargo install-command
  • how to use / cli params
  • License section
@gnunicorn gnunicorn added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Sep 16, 2019
@gnunicorn gnunicorn changed the title Readme needs some ❤️ Readme needs some LUV Sep 16, 2019
@gnunicorn gnunicorn added this to the 1.0 milestone Sep 16, 2019
@redoxeon
Copy link

I could help out with this :)

@gnunicorn
Copy link
Owner Author

@redoxeon very much welcomed. Yes do the changes and raise a PR!

I am not even certain what I am expected to improve beyond what is said above having additional things said above. Maybe the standard-readme spec has some inspiration 🤔 ?!?

@redoxeon
Copy link

oh yeah, the standard-readme spec has some good stuff. I'll add whatever I can and see if I can get a good screenshot added in

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed
Projects
None yet
Milestone
1.0
Development

No branches or pull requests
2 participants
@gnunicorn @redoxeon