About ReadMe
ReadMe is a hosted documentation platform for APIs and developer products. It brings guides, API references and interactive features together in one place.
What it does
You write guides and reference pages in an editor, or import an OpenAPI file and let ReadMe build the API reference from it. Developers can try API calls from inside the docs, and an assistant helps them search the content. Your docs can be synced with GitHub or GitLab, and changes can be reviewed on branches before they are merged.
Key features
- Interactive API reference from an OpenAPI file
- Guides and recipes in one docs site
- Sync docs with GitHub or GitLab
- Review docs changes on branches before merging
- An AI writing assistant and style linter
Who it's for
ReadMe suits API companies and developer product teams that want polished, hosted docs without managing the infrastructure. It works best for teams that need both written guides and interactive API references in the same place.
Pricing and good to know
ReadMe is a hosted service, and its site offers a Get started option. Compare the current plans to see the features and pricing that match your needs before you commit. Because the platform is hosted, your docs live on the vendor's service, and the sync options depend on the Git provider you use.
Highlights
- Build an interactive API reference from an OpenAPI file
- Write guides and recipes in one docs site
- Sync docs with a GitHub or GitLab project
- Review docs changes on branches before merging
- Check writing style with an AI-assisted linter
