# ReadMe

> ReadMe is a developer documentation platform that lets teams build, publish, and maintain API references, guides, changelogs, and help centers with AI-powered writing and review tools.

ReadMe is a full-stack developer documentation platform built by a San Francisco-based team and founded by Gregory Koberger. It covers the entire documentation lifecycle — from writing and reviewing to publishing and measuring — with a WYSIWYG editor, bi-directional Git sync, and a growing suite of AI tools. The platform is actively developed and recently launched a major redesign the team calls "ReadMe Refactored."

## What It Is

ReadMe is a hosted documentation platform designed for API-first companies and developer-facing products. Teams use it to publish API references auto-generated from OpenAPI/Swagger/Postman specs, write narrative guides and recipes, maintain changelogs, and run community discussion forums — all under a custom domain. The platform positions itself as "the full documentation stack," covering everything from a WYSIWYG editor to developer metrics dashboards that show how individual users interact with API endpoints.

## AI-Powered Writing and Review

ReadMe has built several AI capabilities directly into the editing workflow:

- **AI Writing Agent (Owlbert):** An in-editor assistant that drafts, edits, and reformats content on request.
- **AI Linter:** Enforces a custom style guide on every page, flags passive voice, broken links, and example integrity issues, and scores pages out of 10.
- **AI Branch Reviews:** Runs the linter automatically before a branch is merged, catching issues before they go live.
- **GitHub AI Writer:** Monitors pull requests and proposes documentation updates when code changes, landing them on a review branch rather than live docs.
- **Docs Audit:** Scores an entire documentation project against a custom style guide at scale, surfacing voice, terminology, and structure issues across all pages.
- **Ask AI:** A chat-based assistant embedded in the published docs so end users can get instant answers powered by the project's own content.
- **MCP Server:** Lets teams manage and update docs from Claude Code, Cursor, or CI pipelines using the Model Context Protocol.

## Git-Backed Workflow and Collaboration

ReadMe supports bi-directional sync with GitHub, GitHub Enterprise Server, and GitLab. Writers can work in the browser WYSIWYG editor or directly in their IDE; changes flow through a branching model where edits are staged, reviewed, and approved before merging to the live version. Enterprise teams can enforce review requirements so no branch merges without the required approvals. Audit logs track every change across the project.

## API Documentation Features

Uploading an OpenAPI, Swagger, or Postman spec generates an interactive API Reference with live "Try It" request execution, code samples in 60+ languages, and authentication handling. For teams without a spec, a visual API Designer lets writers define endpoints, parameters, and error responses without writing YAML or JSON. The `rdme` CLI (MIT-licensed, available on npm) handles spec validation, syncing, and changelog uploads and can run as a GitHub Action.

## Enterprise Readiness

The platform is SOC 2 and GDPR certified. Enterprise features include role-based access controls (Viewer, Editor, Admin), SAML/OAuth 2.0 SSO with Microsoft Entra ID, Google Workspace, and Okta, multi-project management with a global landing page, global reusable content libraries, Transifex and Smartling integrations for multilingual docs, and dedicated implementation and migration services. The enterprise page lists customers including NVIDIA, Amazon, Airbnb, Miro, PagerDuty, and others.

## Update: ReadMe Refactored and Recent Releases

The homepage announces "A fresh new ReadMe is here!" linking to a May launch post. The platform now runs on what the team calls ReadMe Refactored, which requires `rdme@10` or later for CLI users. Recent doc releases listed on the homepage include AI Branch Reviews, GitLab bi-directional sync, the AI Writing Agent, the AI Linter, Docs Audit, and MCP Server support. The `rdme` CLI reached v10.9.1 on June 6, 2026, and is actively maintained under the MIT license at github.com/readmeio/rdme.

## Features
- WYSIWYG editor backed by Markdown and MDX
- Auto-generated interactive API reference from OpenAPI/Swagger/Postman specs
- Bi-directional sync with GitHub, GitHub Enterprise Server, and GitLab
- AI Writing Agent (Owlbert) for drafting and editing docs
- AI Linter with custom style guide enforcement
- AI Branch Reviews before merging
- GitHub AI Writer that proposes doc updates on code changes
- Docs Audit for scoring entire projects against a style guide
- Ask AI chat assistant embedded in published docs
- MCP Server for managing docs from Claude Code, Cursor, or CI
- Branching and review workflow with approval requirements
- Versioning and version management
- Changelog, recipes, and discussion forums
- Reusable content blocks
- Custom MDX components and marketplace
- 40+ built-in interactive widgets
- Custom domain support
- Role-based access controls
- SSO via SAML, OAuth 2.0, Microsoft Entra ID, Google Workspace, Okta
- Audit logs
- Multi-language/localization support with Transifex and Smartling
- Developer metrics dashboard (API call logs, error rates, per-user activity)
- LLMs.txt generation
- CLI (rdme) and GitHub Actions integration
- Visual API Designer (no spec required)
- PDF export
- 404 redirect rules
- SOC 2 and GDPR certified

## Integrations
GitHub, GitHub Enterprise Server, GitLab, Bitbucket, Google Analytics, Intercom, Segment, Slack, Zendesk, Statuspage, Smartling, Transifex, Localize, 1Password, Postman, OpenAPI/Swagger, AWS Marketplace, Microsoft Entra ID, Google Workspace, Okta, Claude Code, Cursor

## Platforms
WEB, API, CLI

## Pricing
Freemium — Free tier available with paid upgrades

## Version
v10.9.1

## Links
- Website: https://readme.com
- Documentation: https://docs.readme.com/main/docs
- Repository: https://github.com/readmeio/rdme
- EveryDev.ai: https://www.everydev.ai/tools/readme