I'm playing around with a pet project of mine that is a static site generator written in Ruby. While the project itself is not important, what I'm curious about is what people need and look for when reading a README of a software project?

https://github.com/pusewicz/statique

I would love to hear your opinions and feedback in regards to the current state of the README.