Getting Started With ReadMe

Our knowledge base of everything you’ll need to build your beautiful, interactive, and personalized developer hub.


  1. Quick Start Welcome! Get started with an overview of ReadMe basics and an intro to your dashboard ReadMe documentation with color input picker and Owlbert (ReadMe mascot) overlayed
  2. Project Setup Learn how to set up your project, API, & API importing and user login options
  3. Documentation Discover helpful resources on structuring, writing, and maintaining your docs
  4. Developer Dashboard Surface API keys in the hub and understand your API’s performance
  5. Developer Community Connect with your developers to build community and keep them in the loop
  6. Project Customization Tips to make your hub shine, including customizing your hub design & navigation
  7. Account & Settings Looking for resources on managing your account, plan, or team? It’s all here
  8. Technical Support Can’t find what you’re looking for? Read FAQs, reach out to support, & share requests here


  1. Enterprise Overview Welcome to ReadMe Enterprise! Discover features & tips to launch your Enterprise group
  2. Group Management Resources on setting up and managing Enterprise Group-level features
  3. User Management Questions about user authentication or permission levels? It’s all here
  4. Enterprise Workflow Learn about best practices for managing and staging content across Enterprise projects

Programmatically update documentation in your hub with ReadMe’s API. Learn how to authenticate and get started quickly.

Check Out Our API Reference

Community Discussions

Ask questions, share thoughts, and connect with other ReadMe users!

Avatar of Owlivia, the owl How do I send a hoot to the parliament?
Join the Discussion

Our Changelog

All Changelog Posts
    Loading Changelog Posts...

Get Inspired

Thousands of companies use ReadMe to power their developer hubs. Allow our happy customers to inspire you!

Read Stories

Plans & Pricing

Not sure which ReadMe plan suits you best? Take a look at all of our plans and what features are included in each.

See Plans

We’re Hiring!

We’re a tight-knit and fun-loving team of humans (and one adorable owl) working on a product we care about.

Explore Jobs