Skip to content

Instantly share code, notes, and snippets.

@plhnk
Last active January 21, 2021 05:20
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save plhnk/9b52c8b9cb0a851fd865f5f859dca433 to your computer and use it in GitHub Desktop.
Save plhnk/9b52c8b9cb0a851fd865f5f859dca433 to your computer and use it in GitHub Desktop.

Tweet

  1. Good use of badges (build passing, etc), emojis, short code snippets
  2. Improve the demo
  3. Add Screenshots to the readme
  4. If you’re using newer APIs, indicating browser support

Tweet

  1. Solid readme, good links to docs, contributing
  2. Use syntax highlighting in code snippets —> ```lang
  3. Link to the page examples, not just images
  4. Embed components directly vs. using codepen (see Chakra)

Tweet

  1. Good screenshot at the top, good Readme
  2. Clean up open PRs, esp from Bots —> discourages potential contributors
  3. Site — try to spruce up the template, or do something unique
  4. Make application available on a url, use fake data so people can play around

Tweet

  1. Readme has good stuff, but I don’t know how to use it —> npm install?
  2. Docs site —> how can I use it right now?
  3. Pitsby is great for generating Vue documentation
  4. Looks very complete, but no CTA — include GitHub star / fork

Tweet

  1. Good name / explanation — very straightforward
  2. Consider putting a live demo —> nothing more powerful

Tweet

  1. Name is confusing, just the name of the service
  2. Readme is in Portuguese, suggest translating it to English
  3. Site is nice, demo is good —> you could profile the input w/a sample article

Tweet

  1. Its a little vague at first, takes a bit to figure out what it does
  2. Readme feels empty, contributing steps are good — list all functionalities in the readme?
  3. Demo works and is helpful —> but whats the best way to display the information? Can do the same w/Alfred —> maybe an Electron app could be something to explore.

Tweet

  1. Great Readme, a good logo helps —> sponsors and contributors are great social proof, lots of people behind it
  2. Site: would add more content to the landing page, missed opportunity to share benefits
  3. Showing the limitations is great, creates trust
  4. Documentation is nice —> giving common use-cases is really nice
  5. Consider a focused screenshot of the GH release on the homepage, makes it more clear

Tweet

  1. Lots of text, try to explain the amount of text —> 1 or 2 lines to summarize
  2. Edit —> you don’t need to say performance wasn’t a focus
  3. Architecture drawings are good
  4. Code snippets are really big —> Readme is more to give hints, consider decreasing size of snippets if possible
  5. A site would be a good complement

Tweet

  1. Love the readme, center aligned logo, techs it was built with
  2. Demo —> predefined templates are great
  3. Awesome demo, dark mode
  4. Ads hint that the maintainer wants to monetize —> think about your SEO strategy, use your own domain instead of Vercel
  5. Not clear how to contribute —> there seems to be interest from others

Tweet

  1. Logo, badges, gif is great —> TOC, emojis, great
  2. Code snippets could be shorter, overall great readme
  3. Overall really great —> why low visibility? Distribution —> share on Twitter, Dev.to, Hackernews

Tweet

  1. Good position / messaging / readme
  2. Remove extra spaces / unnecessary characters in code snippets for a better copy/paste/use experience
  3. Hard to navigate in the docs site —> put screenshots of the components in the readme
  4. Move examples to be the first tab

Tweet

  1. Links, docs, video is great
  2. Why not link the site from GitHub
  3. Readme is good —> you’ve got the gifs on the site, consider embedding in the repo and on your Wordpress page

Tweet

  1. It’s a very, very niche project
  2. ASCII art is great, readme is nice
  3. Deploy button is the best way to showcase your projects
  4. Consider creating a docker image and showcase on docker hub

Tweet

  1. Highlights are good, very compelling to use over regular Puppeteer
  2. Huge features: Generate a screenshot from code hosted somewhere, choose a theme, generate screenshots w/fancy overlays —> highlight those
  3. Documentation —> needs syntax highlighting
  4. W/the minimalistic vibe, consider adding a dark mode

Tweet

  1. Raises a flag that its JSON/XML/YAML/CSV all in one —> performance hit
  2. Focus on what you’re delivering, adding the inspiration links later one
  3. Docs are great —> examples are nice and simple, mitigates perf concerns
  4. Site is kind of simple and a little boring, consider a live demo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment