search

rosekamallove / youtemy

A great way to learn from YouTube courses without any distractions and the ability to enroll in courses and track them with a daily streak to become more consistent.
https://youtemy-bc22a.firebaseapp.com/
MIT License
39 stars 12 forks source link

Improve the Readme File #70

Closed rosekamallove closed 3 years ago

rosekamallove commented 3 years ago

Currently, the Readme.md basically sucks IMO It would be really nice if it can be updated and made better

MattRudy commented 3 years ago

Hey @rosekamallove , what improvements are you hoping to see to the Readme?

  1. Visually-appealing formatting
  2. Introduction to the project
  3. Badges to track test pass/fail state for actions
  4. Badges for other things like license, code coverage, latest release, number of viewers, etc.
  5. Quick-links to important parts of the README
  6. (Anything else?)

Let me know which of these you'd like to see, which of these are most important, and if there are any projects with Readme files you really like / want to draw inspiration from!

I can support you on this - please assign the issue to me.

rosekamallove commented 3 years ago

I think this is more than what I need and I would be really thankful to you.

P.s. I don't really have any readme in mind, I think I'll be impressed pretty easily!

Edit: This Readme Looks Quite Nice

MattRudy commented 3 years ago

(I deleted that forked repo, Rose had linked to this project: https://github.com/Sacramentix/WikiAdventure )