2
2 Comments

A UI Kit for ReadME files?

Hey its Brayden here again. Its been a bit since I posted.

I just had an idea today that I think could work well.

If you’re a developer, you are used to seeing README.md files in code repositories and probably have to make quite a few yourself.

I want them to be presentable and neat looking. However they take up a lot of time. (and they really shouldn’t)

Like, come on! We have UI kits for Figma, HTML, React, abd many other platforms. I’d say its time for Markdown files to have one.

This will be open sourced and live on a website with a look similar to TailwindUI.com.

What do you think?

posted to Icon for group Ideas and Validation
Ideas and Validation
on May 4, 2022
  1. 1

    Sure, I’ve researched several READMEs and other files for my projects and always thought it’d be nice to have more of a template. Do you have a newsletter so I can stay updated?

    Other bonuses could include:

    • examples of great READMEs and why
    • previews of the README in GitHub, npm, dockerhub, pypi, indiehackers, etc.
    • compatible components like centered items, dropdowns, etc.

    If you expand on READMEs, you could also include:

    • Contributor License Agreements
    • Contributing guidelines
    • Code of Conduct
    1. 1

      Neat! Yeah I think those are some good points.

      Hm, I don’t have a newsletter just yet but I’ll be setting one up soon and I’ll let you know. Thanks!

Trending on Indie Hackers
710% Growth on my tiny productivity tool hit differently, here is what worked in January User Avatar 32 comments You roasted my MVP. I listened. Here is v1.3 (Crash-proof & 100% Local) User Avatar 23 comments Is there any point in creating a product in a crowded market? User Avatar 16 comments Why I built a 'dumb' reading app in the era of AI and Social Feeds User Avatar 13 comments Do startups need marketing services? (Insights from a seasoned marketing team) User Avatar 2 comments The hidden cost of using too many “small” apps User Avatar 1 comment