Hacker News new | ask | show | jobs
by nevinera 5323 days ago
Your readme should include:

What problem does it solve? How much effort will it take for me to understand it well enough to use it?

It should not consist entirely of a line telling me to read index.php.