Roast our GitHub Readme (open-source devtools startup)
As an open-source devtools startup our GitHub Readme is a crucial landing page, but it is hard to debug because we cannot run any analytics on it.
- IndieHackers, what do you think we do?
- What are the first things you check when you explore a GitHub repo/project?
- How do you decide whether you trust a project to use it in your code/app?
- What is the best GitHub Readme you have ever seen (share it please)?
And now, roast it: https://github.com/NangoHQ/nango
Thanks! ❤️
"The best way to sync data from external APIs" too broad. Why type of sync? To where?
This is better 'Nango continuously syncs data from any API endpoint to your local database and keeps it fresh for you.'
I would re-write the above to be 'Automatically pull data from external APIs to your database'
Under the 'Can you show me an example?' section show the response. It matters. JSON? stream? blob?
"🧑💻 Cool, who uses it?" section is weak. Give me specific use cases not generalities.
Why would a need to sync an external API to a local db? Make that clear to get more users.
Good luck!
Thanks @joshdance, good feedback!
Regarding the response, what would you expect to see here? Nango pulls data into your database, so our output are table rows.
Thanks for the input on "who uses it", will think about how to improve that one
Just how it comes back from the API. Pick an example data source, and show 2 rows etc.