Description Section

Your README's project description should come after the title and have 1 or maybe 2 sentences about what your project does. State it as simply as possible. For example:

Zipzod is a command-line tool in Go for zipping and unzipping files with an ultra low memory footprint.

Wrapper of rabbitmq/amqp091-go that provides reconnection logic and sane defaults.

-- go-rabbitmq

The fun, functional and stateful way to build terminal apps. A Go framework based on The Elm Architecture. Bubble Tea is well-suited for simple and complex terminal applications, either inline, full-window, or a mix of both.

-- bubbletea

Don't Minimize Your Work

Never minimize your work with language like "just", "toy" or "test". Avoid saying things like:

• This is just a toy app
• This is just a test project
• This is for practice

These imply that you built a toy project because you don't have the skills to build a "real" one. Take pride in your work!

Show Don't Tell

After a short text-based description, add an image, GIF, live link, or video that shows your project in action! Hiring managers are lazy have limited time, so make it as easy as possible for them to see what you built!

Bubble Tea's repo has a great example of this: