👋 Welcome to ReadMe!

We're here to help you create an interactive developer hub that makes your APIs easy to use and maintain. With ReadMe, you'll give your developers the guidance they need to get started quickly and troubleshoot effectively along the way.

Getting started

Creating a project is the first step towards building comprehensive and user-friendly documentation. This process involves setting up your project with a name, subdomain, and logo that match your brand's identity. Follow the steps below to get started:

1
Sign up/Log in

Go to ReadMe and sign up for an account if you haven't already. If you have an account, log in.

2
Create a New Project
  1. Once logged in,, click "Create New Project".
  2. Give your project a name that resonates with your API.
  3. Upload your logo (we'll work our magic to match your brand colors!).

Nice work! Now that you've created your project, you'll land on our Quickstart page in your Project Dashboard. Head to our Quickstart Guide to get started with uploading your first OpenAPI Specification (OAS) file.

Quickstart Guide
Get started with an overview of ReadMe basics and an intro to your dashboard.

Platform Guides

Essential guides to help you set up and manage your ReadMe project.

Enterprise Guides

Advanced features and tools for enterprise-level ReadMe projects.

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