Remaking README from the beginning

How to make a fascinating README file

This article is about what I’ve researched while remaking @egjs/Flicking ’s README for advertisement.

If you’re working on some open-source project, I’ll bet, for your reason, each of you are working on great project.

However, no matter how great your project is and how much time you’ve spent on your project, it is no use that nobody uses what you’ve created.

But unfortunately, time you’ve spent on just writing code can’t be directly connected to number of users.

Figure below is part of Github statistics last year(2018). You can check it by yourself on here . There’s an interesting item. It says about 96 million repositories were created by last year, and nearly one third of them were created in the last year.

“Overview” section of Github statistics 2018

As statistics tell you, there’s really a lot of open-source that’s been created, and it’s still being made.

Unless you create something totally new, or even if you’ve created something that different already, competition is inevitable.

For case of Flicking , Best of JS alone featured 21 libraries to compete.

We also had to try our best to contest our competitors. Flicking is quite competitive library compared to other similar libraries, but it’s not popular at the moment; like Github’s stars are low, npm’s download counts are low, as it’s not advertised well.

Therefore, we tried a lot of things while releasing Flicking ’s new major version. We built new demo page, and we did some advertisement like posting release notice to bunch of websites.