Too Long; Didn't Read
The README will be one of the first things someone sees when they view your project. It is the opportunity to get someone interested in your open source project, or to convince them that you’re an awesome developer or simply to show off the cool project you've been working on in your spare time. Here are 3 areas to focus on when updating or creating your project READMEs: Description, Installation Instructions, Link To a Live Version, Linking to a live version, and Getting it up and running.