Email content

Hi John,

I’m Greg, Founder and CEO of ReadMe. I started ReadMe because docs always felt too static. I’ve always believed they should feel more like the UI and UX for your product. Something that helps developers get unblocked fast, not something they have to fight through.

That’s what we’re building here. A place where your docs feel alive and actually help people use your product, not just read about it. Here’s how to get started:

Build your API Reference

Your API Reference is the core of your hub. This is where people learn what your API does and try things out. You can upload your OpenAPI file, import it from a URL, or sync it with GitHub. If you don’t have a spec yet, the API Designer lets you create one visually.

Add Guides and Recipes

Guides let you show people how things work in context. Think walkthroughs, workflows, and short tutorials. The MDX editor keeps it simple. Write in Markdown and add interactive elements. Switch to View mode to see exactly what your readers will see.

Make the experience personal

Behind every change is a real person trying to get something done. ReadMe pulls in real request data so your users see their own keys, their own history, and the exact info they need to troubleshoot.

Work with your team

Invite your team to contribute to docs. You can edit together, request reviews, or use Branching to draft changes before publishing. If you prefer working in GitHub or GitLab, you can do that too while keeping everything in sync.

I’m really glad you’re here! Great docs create great developer experiences, and you’re already on your way.

Greg

Founder and CEO @ ReadMe

Start Building Your Docs

ReadMe, 14 Geary Street, Floor 2, San Francisco, CA 94108

Unsubscribe

Manage preferences