GitHub is Your Landing Page

A presentation at APItheDocs in in Amsterdam, Netherlands by Lorna Jane Mitchell

Having a good README file in every GitHub project is a key ingredient of good developer experience, but what makes a good README? This session looks at the various types of projects you might want to create a README for, and offers examples of good README practice in each case. Making sure the purpose and status of the project is key, and directing users to your (beautiful and actively maintained) main documentation is definitely part of the deal. But we can do more to engage and inform developers that reach our projects this way, and this session will show you how. Recommended for everyone who wants to make the projects we create a welcoming place for users, however they find us.



The following resources were mentioned during the presentation or are useful additional information.

  • Repository Standards

    Here is where we keep our templates and checklists for setting up good github repositories

Buzz and feedback

Here’s what was said about this presentation on social media.