I do like READMEs that have this hero-like header part as shown in this example. It looks professional and I don't have the feeling that this is just made for experts.
🇩🇴 I'm a Technical Program Manager and Content Strategist with an MSc in UXD. I help developers become better content creators and DevRel teams build robust content programs.
I spend a lot of time in Postwoman's readme.
👽 A free, fast and beautiful API request builder used by 75k+ developers. https://hoppscotch.io
A free, fast and beautiful API request builder
Helps you create requests faster, saving precious time on development - Subscribe
Built with ❤︎ by
liyasthomas and
contributors
Chat: Telegram, Discord
Donate: GitHub Sponsors, Open Collective, Patreon, PayPal
Table of contents
Features✨
Methods:
GET- Retrieve information about the REST API resourceHEAD- Retrieve response headers identical to those of a GET request, but without the response body.POST- Create a REST API resourcePUT- Update a REST API resourceDELETE- Delete a REST…I do like READMEs that have this hero-like header part as shown in this example. It looks professional and I don't have the feeling that this is just made for experts.
Thanks for sharing, Liyas—indeed, it's very detailed.
Did you take inspiration from other projects? How did you cmake the decision to structure your README the way you did?
I remember finding a public gist which had most of the sections for a README boilerplate. I don't have the link to it with me now.
Wow that's a really great project!