At the moment, the Readme seems to be a writeup of the project proposal. It's great to have some background information, but I would recommend cutting it down and changing it to reflect the current functionality of your module, rather than the proposed future functionality. In addition, it should document things like the python package requirements, installation instructions, and so on.
At the moment, the Readme seems to be a writeup of the project proposal. It's great to have some background information, but I would recommend cutting it down and changing it to reflect the current functionality of your module, rather than the proposed future functionality. In addition, it should document things like the python package requirements, installation instructions, and so on.