I see a lot of documentation describing how it works, not what it does. I think most README.md files would be better as code comments. Personally, the most usef

I see a lot of documentation describing how it works, not what it does. I think most README.md files would be better as code comments. Personally, the most useful documentation contains a brief summery of purpose, usage, and then a few examples. Dependencies should be called out if they are significant.