---
updatedAt: 2026-09-23T19:21:15.000Z
agentTools:
  siteIndex: https://docs.readme.com/llms.txt
  siteSearch: https://docs.readme.com/agentSearch?query=term1%20term2
  projectIndex: https://docs.readme.com/main/llms.txt
  projectSearch: https://docs.readme.com/main/agentSearch?query=term1%20term2
---

# Quickstart

Get your API documentation live in three steps: create a project, upload your API definition, and write your first guide.

Get your API documentation live in three steps.

<Cards>
  <Card title="1: Create Your Project" href="#step-1-create-your-project" icon="fa-palette">
    Sign into ReadMe, name your project, and upload your logo.
  </Card>

  <Card title="2: Add Your API Spec" href="#step-2-add-your-api-spec" icon="fa-file">
    Upload an OpenAPI file or URL to generate interactive API reference docs.
  </Card>

  <Card title="3: Write Your First Guide" href="#step-3-write-your-first-guide" icon="fa-pen">
    Create a getting started page using the editor or the AI Agent.
  </Card>
</Cards>

## Step 1: Create Your Project

1. Sign into your ReadMe account.
2. Click **Create New Project**.
3. Name your project.
4. Upload your logo — ReadMe matches your brand colors automatically.

## Step 2: Add Your API Spec

Upload your OpenAPI specification to generate an interactive API reference with endpoint descriptions, request/response examples, and a built-in API explorer.

<Tabs>
  <Tab title="Upload File">
    1. Click **Upload OpenAPI file**.
    2. Select your OpenAPI/Swagger spec file.
    3. ReadMe validates and processes the spec.
  </Tab>

  <Tab title="Import via URL">
    1. Paste your OpenAPI specification URL.
    2. Click **Import OpenAPI file**.
    3. ReadMe fetches and validates the spec.
  </Tab>
</Tabs>

After upload, you'll see a preview of your endpoints and documentation structure. Click **Go to Docs** to see the live result.

No OpenAPI file yet? Click **Skip to Docs** — you can add one later from project settings.

## Step 3: Write Your First Guide

Guides are the pages that sit alongside your API reference — getting started tutorials, authentication walkthroughs, and conceptual explanations. You have two ways to create them:

### Option A: Use the Agent

Open the Agent from the chat icon in your editor. Describe what you need and the Agent will draft it, pulling from your uploaded API spec for accuracy.

Try a prompt like:

* "Write a getting started guide for my API"
* "Create an authentication walkthrough with code examples"
* "Draft a guide explaining our webhook system"

The Agent writes in Markdown with ReadMe's MDX components. Review the output, edit as needed, and save.

### Option B: Write in the Editor

1. Toggle into **Edit Mode** from the top navigation.
2. Click **+ NEW CATEGORY** and name it (e.g., "Getting Started").
3. Click **+** next to the category to create a page.
4. Type `/` to insert code blocks, callouts, images, tabs, and other components.
5. Toggle between **Edit** and **View** to preview.

## What's Next

<Cards columns={2}>
  <Card title="Set Up AI for Your Readers" href="https://docs.readme.com/main/docs/ai-overview" icon="fa-sparkles">
    Enable Ask AI, MCP servers, and LLMs.txt so your users can query your docs with AI tools.
  </Card>

  <Card title="Configure the Linter" href="https://docs.readme.com/main/docs/linter" icon="fa-wand-sparkles">
    Set up your style guide rules and validate documentation as you write.
  </Card>

  <Card title="Customize Your Hub" href="https://docs.readme.com/main/docs/design-themes" icon="fa-paint-brush">
    Add your brand colors and custom domain.
  </Card>

  <Card title="Sync with GitHub" href="https://docs.readme.com/main/docs/sync-with-github" icon="fa-code-compare">
    Connect to a GitHub repo for collaborative editing via pull requests.
  </Card>

  <Card title="Preview Docs Locally" href="https://docs.readme.com/main/docs/cli#preview-docs-locally" icon="fa-laptop-code">
    Run `npx @readme/cli dev` to preview Guides and API Reference changes locally with hot reload.
  </Card>
</Cards>

<br />

# Sibling pages

* [Welcome to ReadMe](https://docs.readme.com/main/docs/about-readme.md)
* [Build with AI](https://docs.readme.com/main/docs/ai-overview.md)
* [Migrating to ReadMe](https://docs.readme.com/main/docs/migrate.md)