3 ms·
[ Disclaimer: I have no OS libs to my own name, but I: (a) do enjoy using a good bunch of them ;-) and (b) I hold a degree in Advertising, if that helps on
by joao_arau 10y ago
[ Disclaimer: I have no OS libs to my own name, but I:
(a) do enjoy using a good bunch of them ;-) and
(b) I hold a degree in Advertising, if that helps on anything :-P ]
So here's a couple of things that I was able to notice right upfront that can help you improve:
Improvement 1: Your long textual diatribes are most definitely scaring people away (including myself!). Seriously, even inside your code samples has long, +10 line comments, what's up with that? No wonder you're having such a high bounce rate!
What you have to understand is that developers don't want to be told why they should use our library. Instead, they want to just "get it". In other words, they want to be invited into the discovery process and reach that conclusion by themselves - usually by seeing some practical application (aka code samples) and deciding by themselves if they like what they see and if it looks like something that works for them ... this discovery process is a big part of the fun of picking up new tools for ourselves and should not be underestimated.
So, to put it on more practical terms, make sure you use a code-first approach to your ReadMe file and begin with commented code samples, not explanations, and make sure the code comments are no longer than 2 lines, too. Also look around at the ReadMe of the some of the most successful libs out there and with ideas above in mind and I'm sure you will quickly recognize some best practices and nifty tricks that you can emulate in your own ReadMe file.
Improvement 2: Another thing you can do is put a gitter/discord/slack button up there and also make sure you're making yourself available as much as possible for quick feedback. This is not 1999 anymore and with all the hundreds libs out there fighting for developer mind-share, people tend to favor solutions which have some sort of community/ecosystem they can rely on for those though moments.
Improvement 3: Finally, a video tutorial is something that a lot of people out there are linking to on their ReadMe, as it's a great way to show that you really "means business" when it comes to getting people up to speed with your lib. The reasoning for them is that -- "Hey if someone went to all the trouble of investing his/her time to make a video just to show me how to use this thing, maybe I should really invest some my own time to take a closer look at this".
If you don't feel like you can make a good job of doing the video, just find someone to do it for you - but make sure it has: a) nice, clear audio b) large, visible text; c) 5 min or less of duration d) A hands-on approach to it (aka less talking, more coding).
Hope these suggestions help a bit and good luck conquering the World with your lib ;-)