In its current state, the README does not really help others. It should be updated to have installation and configuration instructions, and tell the user how to run it, and what it needs to be usable. Also, where to look for output, etc. The usual kind of information in a README, that is.