ReadMe

ReadMe converts static API documentation into interactive, up-to-the-minute developer hubs. The service helps developers succeed by offering tutorials, code examples and real-time API logs that let developers debug and understand how their APIs are used.

ReadMe has a number of features to help you build a better developer experience:

• Public & Private Hubs: Control who can see what.
• OpenAPI Sync: Synchronize OpenAPI files with the CLI, GitHub Action or file upload.
• GraphQL Support: Includes a GraphQL API playground for exploration.
• Try It API Playground: Let users try out APIs and auto-generate code snippets.
• Suggested Edits: Let users suggest changes to keep documentation fresh.
• Versioning: Support multiple versions of API documentation.
• Unified Navigation: Unify navigation and make it easy to find what you need.
• Branding Control: Customize the look and feel of the developer hub.
• Content Widgets & Markdown: Embeddable widgets and a modern markdown editor make writing documents a breeze.
• Native Search: Algolia-powered search helps users find what they need fast.
• Page Views & Ratings: See how engaged users are and get feedback.
• Real-time API Logs: See how your API is used for debugging and insights.
• User Metrics: See how your API is being adopted and how often it's throwing errors.
• Changelog & Discussion Forums: Keep users up to date on changes and let them request features.

Pricing tiers are designed to accommodate different needs:

• Free: Create an API reference with OAS/Swagger support, API versions and advanced request history.
• Startup ($99/month): Includes custom domains, guides, changelogs and discussion forums.
• Business ($399/month): Includes custom CSS/HTML, reusable content and export metrics data.
• Enterprise ($3000+/month): Supports multiple APIs in one hub, advanced permissions and security requirements.

ReadMe also offers add-ons, including a Developer Dashboard for real-time API insights and Owlbot AI, a chatbot trained on documentation to help users. Sign up for a 14-day free trial to try these out and build a developer hub that meets your users' needs.

Published on July 10, 2024