write adequate readme

we should add relevant information to readme.md about our project so that people will have to spend less time to understand what is going on

[here](https://www.lullabot.com/articles/managing-projects-with-github) are some tips. we can find other ideas with the power of google (tm) and use them if we please

Start by reviewing README.md and the linked article for possible information to include. The issue does not identify specific project details or sections to document; it is complete when the README contains relevant information that helps readers understand the project with less effort.

Written by the indexing model from the issue text.