9 ms·
Show HN: Pimp My Readme
- joshdsouza 5y agoHey, I'm Josh & I wanted a way to add some customization to my readme, so I made this at my company hackathon last week. This is an open source project so if you want to contribute just add your component and put up a PR. Thanks for your feedback! GitHub repo here: https://github.com/joshdsouza8/pimp-my-readme https://github.com/joshdsouza8/pimp-my-readme
- elanning 5y agoAwesome hackathon project. The font scroll is great 90s website nostalgia.
- joshdsouza 5y agoThanks! 90s web nostalgia is what I was going for :P
- jdauriemma 5y agoThank you for sharing! For those using this service, please keep in mind that screen readers are not able to access text in images. Since the markdown output does not contain `alt` text, use care when copypasting this into your `README.md`; someone who is visually impaired will not be able to perceive it. Further reading: https://www.w3.org/TR/WCAG20-TECHS/H37.html https://www.w3.org/TR/WCAG20-TECHS/H37.html
- joshdsouza 5y agoThanks for catching this! I'll make an update adding the alt text as default when copy & pasting
- deleted 5y ago[deleted]
- denton-scratch 5y agoI can't read your README; I can't scroll down. Sorry.
- joshdsouza 5y agoHey, could you give me a little more detail on what you're seeing (i.e. what browser are you using), would love to fix it so you can check it out. Thanks!
- denton-scratch 5y agoIt seems to have improved now - I can scroll fine. This is still the same browser session. I'm on a laptop running FF 93.0, with Noscript and Adblocker Ultimate, both enabled. FF is running full-screen. It's Win10. I didn't record what I saw earlier. Now, I see a number of clickable placeholder images, and a bunch of "Try me" buttons. My impression is that the site is for making marketing-friendly tags. That's cool, just not my thing. I didn't click.
- humpday69 5y agoSorry to be that guy but are we really going with "pimping" in 2021? After that master branch thing I thought we were trying to be less edgy with naming.
- divbzero 5y agoLove the 90s nostalgia. Could also add something like… <blink>🏗 This page is under construction. 🚧</blink>
- joshdsouza 5y agoHaha that’s a great idea! Let’s bring the blink tags back, I’ll add it in tomorrow. Also project is open source as well so if you have any ideas, you can open an issue for it (which I will get to) or just add it in whenever you can :)
- smusamashah 5y agoI previously used something like that to add number of visitors on a repos Readme. Now it shows a broken image icon only because that service has been shut down. Best option to use it continously is to host your own version and use that instead of the one you are providing.
- joshdsouza 5y agoThanks for the feedback! I got permission to host the project on my company’s website after the hackathon, so it will be up indefinitely ;) There’s also the option to just clone the repo, run, and host the server on your own as well, up to you.
- rob74 5y agoThe emojis in the "Hey, I'm Jellybear!" marquee line look more like "octopus-bear" (or "octobear", to compliment GitHub's "octocat"?). Not sure if there's a jellyfish emoji though...
- andrew_ 5y agoUsing the Facebook social icon given current events is just a smidge tone deaf.
- andrew_ 5y agoI would genuinely like to read the rebuttals from folks who've downvoted this. Please, share your perspective.
- Bayart 5y agoThe assumption that there's a « tone » to be aware of is irritating. Not everyone follows the latest developments of tech drama or cares about it.
- grayhatter 5y agoDownvotes unfortunately do often only indicate disagreement. What makes it's tone deaf? I suspect the common observation people would make is similar to "Because you don't like it, other's shouldn't like it as well?"
- andrew_ 5y agoMy reply to a sibling comment addresses your question: https://news.ycombinator.com/item?id=28983525 https://news.ycombinator.com/item?id=28983525
- bcyn 5y agoCool, you dislike Facebook, but does that add value to the discussion about this project?
- andrew_ 5y agoI think it does. There's a litany of information out now about how bad Facebook is - for everyone. The author is soliciting feedback, and to feature a Facebook icon as the social link on the demo doesn't take that into account. It's not a matter of liking it or not.
- woodruffw 5y agoI've noticed a lot of projects in the past few years put a lot of stuff like this in their READMEs, with the (presumable) end goal of making their repository really "pop" on GitHub. That's perfectly fine! But sometimes it goes so far as to actively impede reading the README in a text editor, since it's now full of tables and Markdown abuse aimed at making it render correctly on GitHub. It also has a tendency to break other sites (think package management indices) that tend to consume READMEs, as they're now being fed all kinds of weird GitHub-specific Markdown. That leads to an overall worse user experience, e.g. when I'm selecting a package from PyPI or crates.io. Given that projects are now using their READMEs as de-facto `index.html` pages, we really ought to just have an `INDEX.md` or similar convention for presenting all the cute stuff.
- mmahemoff 5y agoIdeally those tools would render a file called README.md as readable HTML. For example, w3m renders this project's README cleanly - https://ibb.co/WPDDL0d https://ibb.co/WPDDL0d
- woodruffw 5y agoThat would be ideal, yeah. But I don’t begrudge them for failing to do so: GitHub-flavored Markdown is a significantly more complicated beast than “common” Markdown, which is itself somewhat fragmented.
- gopiandcode 5y agoBeing slightly cynical here, I'd presume that's not a bug, but rather the intended outcome, and this phenomenon with markdown is just a canary for M$'s impeding extinguish phase (after having embraced and extended git forges like github).
- woodruffw 5y agoMicrosoft might be steaming ahead on it, but I think GitHub’s extensions to Markdown predate their acquisition by a few years.
- redwoolf 5y ago
- clooless 5y agoJust to add my insignificant voice, I too was put off by the use of the word. I'm not familiar with the expression "pimp my ride" despite being American from birth. But I do know what a pimp is and it is a negatively, sexually charged word. I'm not asking you to change it, but I think it is to your benefit that you are aware that some subset of commenters here find it uncomfortable.
- sodality2 5y ago>I'm not a fan of the use of the word "pimp" in this context In this context it means "to adapt or embellish in an ostentatious manner".
- mattbaker 5y agoYeahhhh but the context doesn’t negate the fact that the word is a reference to exploitation. I’m with the parent comment on this one. If it was 2005 I probably wouldn’t have blinked but ya know, the world moves on. There are just so many names to pick from! I find the choice very confusing. Too cringe-y for me to consider sharing or using personally, but I’m sure some will and I hope they enjoy it.
- siva7 5y agoWords can have many different unrelated meanings, based on context. Going with sexual exploitation is beyond absurdity when Pimp my X is a well-known cultural reference
- woodruffw 5y agoI’m pretty sympathetic in this case, but to point out the obvious: something being a “well-known cultural reference” isn’t itself a strong justification for using language or symbols that are known to be offensive. An intuitive case for most people: we all recognize the car from The Dukes of Hazzard, but you probably shouldn’t put the confederate battle flag on your own car as a reference to it.
- hartator 5y agoOriginal project: https://github.com/Akshay090/svg-banners https://github.com/Akshay090/svg-banners
- phaedryx 5y agoIt looks like a fun project. However, I like a more subdued and less "pimped" look. I am a fan of https://shields.io/ https://shields.io/, e.g. my github profile: https://github.com/phaedryx/ https://github.com/phaedryx/
- bradhensen 5y agoIt looks good, especially on your side projects. It will make your readme looks fun to read.