Documentation is more important than most people are willing to admit. If you want your project to be used though, you have to invest in it. As a bonus, you might also be able to get some good unit tests for free too. In this series of video's we'll highlight how we've set up documentation for clumper.
You can find the project and the readme on github.
If you're interested in learning more all the readme tricks we're pulling off here you
can find more information in this series of videos.
If you're interested in learning more about
mkdocs you might enjoy
this series of videos as well.