DEV Community

Cover image for I made the best Github ReadMe EVER!

I made the best Github ReadMe EVER!

Milk on September 04, 2022

See for yourself. AFAIK there is no legit people-led and voted ranking awards for Github ReadMe. But you'll be the judge if it really is the best ...
Collapse
 
jmfayard profile image
Jean-Michel πŸ•΅πŸ»β€β™‚οΈ Fayard

Hello, I don't want to be a dick, your README is certainly nice looking, but to be actualy good it would be nice to fix two issues:

  1. First it's barely readable because there is not enough contrast between the background color and the strings color. I can read the keys code, technologies, .. fine but I have to make an effort to read "JavaScript", "TypeScript", ...
  2. Second having all the contents in an image with no text alternative is a classic anti-pattern of web accessibility.

The first issue can be fixed with a more readable theme The second by having a text-equivalent below or something

Collapse
 
milkshakegum profile image
Milk

Omg thank you so much!!! I'll look into it and fix it. 🀍

Collapse
 
tandrieu profile image
Thibaut Andrieu

Well, markdown was created to be readable in plain text (ref)

So on one side, you made the best Github README ever, but on the other side you probably made the worst markdown file ever 🀣

Collapse
 
milkshakegum profile image
Milk

True lol 🀣 Well I tried doing some of them in markdown, but they won't render as well if I did it with HTML. Thanks for the feedback!

Collapse
 
kayis profile image
K

It's technically awesome, but I get strong MySpace vibes from this recent overengineered GitHub README trend :D

Collapse
 
alonedatascientist profile image
alonedatascientist

There really is nothing new under the sun at this point lol. The 80's are coming back hard too.

Collapse
 
milkshakegum profile image
Milk

lolol Yes it is over engineered T_T I had an incessant urge to showcase my CSS skills!! jkjk I had to make up for not having real projects to contribute to the open-source community lol

Collapse
 
kottartillsalu profile image
Maxime • Edited

I like the minimalism on the first page. Like others said, adding a text variant and maybe styling it with colors will create the same effect. Once you click the expand key, it becomes quite excessive. No many people will be interested in seeing what you listen to and or what your ranks in x, y, z are.

Focus on telling more about who you are; what is your passion? why do you code? etc.

Collapse
 
antoniomalcolm profile image
Antonio Malcolm

I think this nails most aspects mentioned, here, but I use actual code blocks in my READMEs, for accessibility, and, also, users can easily copy + paste, from the READMEs, even on mobile. Also, there's a Table Of Contents :

github.com/antonio-malcolm/interre...

Collapse
 
milkshakegum profile image
Milk • Edited

Yes, I agree! The one from the link you sent is definitely ideal for a project's README.

Btw, if u ever need to add stats for contributors, etc of the project(well there is one in the analytics tab but it doesnt have a contributions graph), I found repobeats.axiom.co/. You might wanna check them out.

Collapse
 
lucciddev profile image
lucciddev

Absolute lovely. Love your work and would like to connect.

Collapse
 
milkshakegum profile image
Milk

thank you!!! 🀍 ok lets do it