4 ms·

Show HN: GitHub Readme Testimonials

4 points by smashah 6y ago

smashah 6y ago
Sometimes a little appreciation makes contributing to open-source worth all those hours. I feel like we should wear those commendations from fellow coders as a badge of honour like an award. That's why I built this little 'widget' for your github readme profile. I would love any feedback. Please let me know if you use this! :)
- ayewo 6y ago
  Congrats on shipping! Some feedback: 1. Can you rewrite the summary to be more clear? I had to re-read it a few times to understand what the tool does. Instead of “Show people's appreciation for your contributions on your readme”, how about “Show off nice complements from your users (that you are especially proud of.)” ? 2. The demo seems to have caching enabled, no? I refreshed a few times but was repeatedly shown the image of the same kudos shown in the readme.
  - smashah 6y ago
    Thanks so much for your points. I've used your suggestion and made the description clearer. I've also added non-cached examples Thanks again!
- stennie 6y ago
  An interesting idea! I tried refreshing the README.md expecting to see other testimonials, and I'm seeing the same one every time (from tinyCoder32 on Apr 6). I noticed the suggestion of adding noCache=true to the image path (which I presume means "?noCache=true"), but am still seeing the same testimonial. I also tried force refreshing my browser cache. A few suggestions: - A default README example without caching (and with multiple testimonials) would be a better demo of what your project can be used for. - Consider adding a JS embed option with links to the original GitHub comments for context. The demo image with "It worked, thank you so much for the help." would be a more compelling testimonial if I could see the original discussion to understand who is being thanked and what they actually did.
  - smashah 6y ago
    Hi thanks so much for your feedback. I've implemented better docs and have added multiple demos with and without cache. Regarding the JS embed. I implemented an svg implementation which, if used in your website, it will make the image clickable. However, this is scrubbed for security reasons on Github markdown.

4 points by smashah 6y ago

Sometimes a little appreciation makes contributing to open-source worth all those hours. I feel like we should wear those commendations from fellow coders as a badge of honour like an award. That's why I built this little 'widget' for your github readme profile. I would love any feedback. Please let me know if you use this! :)

ayewo 6y ago
Congrats on shipping! Some feedback: 1. Can you rewrite the summary to be more clear? I had to re-read it a few times to understand what the tool does. Instead of “Show people's appreciation for your contributions on your readme”, how about “Show off nice complements from your users (that you are especially proud of.)” ? 2. The demo seems to have caching enabled, no? I refreshed a few times but was repeatedly shown the image of the same kudos shown in the readme.
- smashah 6y ago
  Thanks so much for your points. I've used your suggestion and made the description clearer. I've also added non-cached examples Thanks again!
stennie 6y ago
An interesting idea! I tried refreshing the README.md expecting to see other testimonials, and I'm seeing the same one every time (from tinyCoder32 on Apr 6). I noticed the suggestion of adding noCache=true to the image path (which I presume means "?noCache=true"), but am still seeing the same testimonial. I also tried force refreshing my browser cache. A few suggestions: - A default README example without caching (and with multiple testimonials) would be a better demo of what your project can be used for. - Consider adding a JS embed option with links to the original GitHub comments for context. The demo image with "It worked, thank you so much for the help." would be a more compelling testimonial if I could see the original discussion to understand who is being thanked and what they actually did.
- smashah 6y ago
  Hi thanks so much for your feedback. I've implemented better docs and have added multiple demos with and without cache. Regarding the JS embed. I implemented an svg implementation which, if used in your website, it will make the image clickable. However, this is scrubbed for security reasons on Github markdown.