search

matiassingers / awesome-readme

A curated list of awesome READMEs
18.16k stars 3.83k forks source link

Add link to kotlin-faker readme example #251

Closed serpro69 closed 7 months ago

serpro69 commented 7 months ago

Hi,

Would love to submit https://github.com/serpro69/kotlin-faker/blob/master/README.md to the list of examples.

I'm a believer in minimalistic approach when it comes to README contents because it's easier to consume, but at the same time think a readme should still be enough to "get started" with any given project. This is what I tried to achieve with the above readme, while also keeping it looking good.

Thanks for your consideration.

Robson commented 7 months ago

Hi @serpro69 thank you for the suggestion! Could you include #readme at the end of the URL? Have a look at the other examples to see what I mean. It may also be beneficial to include a table of contents near the top of the readme, but I'd be happy to accept this with/without that.

serpro69 commented 7 months ago

Hey @Robson , Thanks for the quick reply :) I've fixed the link now. Agreed , a ToC is a nice thing to have for sure. Thanks for the suggestion. I'll add that also once I have a free minute :)

Robson commented 7 months ago

Perfect, thank you @serpro69