README should explain the problem it solves.

[ShawnMilo]

Please take this entire description as well-intended constructive criticism. It is not meant to be offensive, but to help the project. I'm not singling out boxcars, I feel this way about a LOT of projects.

Reading the README, the only explanation given is

Easy-to-configure Static Web/Reverse Proxy Server in Go.

What does that mean? Why would I want to use it? What problem does it solve? This description is most useful to the developer who wrote it, not to the majority of potential users.

I'm a fairly experienced developer, familiar with what reverse proxies do, and even for me, there's nothing there to tell me why I should consider this instead of nginx. Yes, hidden down under benchmarks is a speed comparison with nginx, but having "it's similar in functionality to nginx, but faster" (or whatever is the most important distinction) would be cool up top.

If I were unfamiliar with nginx (or didn't know what a reverse-proxy did in general), and I was maybe a Python or Ruby developer who could take advantage of such a project, there's nothing in the description to tell me I can use this to serve my application. If I did a Google or Github search, I'd almost certainly never encounter this project with the keywords I'd use.

Anyone who's ever been trained in sales knows you always need to sell the benefits, not the features. Most people won't get excited about the specs of a gigabit fiber connection, but tell them they can do in two seconds what currently takes an hour and they'll get out their wallet.

[azer]

thanks for taking time and writing this, I'm open for PR's to explain it better