DEV Community

Atena Dadkhah
Atena Dadkhah

Posted on

How does my GitHub readme look like?🍧

Hello. πŸ‘‹
Yesterday I decided to create a GitHub readme for my profile. Before creating it, I read many tutorials and saw lots of perfect examples.
Now I want to know whether I was successful or not?
Is that a good readme?
Thank you so much.πŸ˜‰πŸ’™

Top comments (5)

Collapse
 
codeystein profile image
codeyStein β€’

I like it! But be careful with the header as due it havninde.g a transparent background, it dosen't look great on light mode

Collapse
 
atenadadkhah profile image
Atena Dadkhah β€’

Thank you. I didn't notice that. πŸ˜…

Collapse
 
atenadadkhah profile image
Atena Dadkhah β€’ β€’ Edited

I used dark/light mode for the header image.

Collapse
 
urwissen profile image
Lars β€’

Very nice, but as mentioned before your header should be adjusted to look good in dark and light mode

Collapse
 
atenadadkhah profile image
Atena Dadkhah β€’

You are right! πŸ‘Thank you I'll fix that.

A Workflow Copilot. Tailored to You.

Pieces.app image

Our desktop app, with its intelligent copilot, streamlines coding by generating snippets, extracting code from screenshots, and accelerating problem-solving.

Read the docs