How to Write a Killer README

An open source project’s README is like a website homepage. It’s the first part of your documentation someone is likely to read, and it's an opportunity for project maintainers to explain not just how someone should get started, but also the outcomes users can expect from using the project. If your README sucks, it will be the only doc that person reads before they go away and use a competing project with a better README. In this talk, Emily Omier will give the audience tips for improving the quality of their READMEs, so that they function both as an evangelism tool as well as a way for people new to the project to get started. She’ll provide concrete examples from projects with killer READMEs.