Writing a Better README.md

A while ago I remember seeing a tweet from Ryan Florence about docuemntation:

I think the biggest mistake we all make in docs and tutorials:
Not explaining *first* what the goal, or use-case, or desired result is.

— Ryan Florence @ 🐙🤖 (@ryanflorence) June 19, 2017

Last week I’d seen that Kent C Dodds had a further point on it, which I liked:

Here’s the order I use in my projects:

Problem
Solution
Installation
Usage
Inspiration
Related
Thanks
Licensehttps://t.co/nCBk52VOiu

— Kent C. Dodds (@kentcdodds) June 20, 2017

So going forward I’m planning to use that as a template along with going over some existing projects and modifying those. I think the extra information contained within the problem and solution areas could really help others who are trying to solve their own problem.