Open source repository readme essentials
The readme file is your users’ first encounter with your repo. It should be able to explain what your product does, in short at first and then in more detail.
Adrian Marin
Author & CEO