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:
Go to ReadMe and sign up for an account if you haven't already. If you have an account, log in.
- Once logged in, click "Create New Project".
- Give your project a name that resonates with your API.
- 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.
ReadMe Refactored
ReadMe has evolved! Our refactored platform introduces powerful new features that transform how you create and maintain documentation:
Create and edit content directly on your docs site with our streamlined interface that shows exactly how changes will look for your users.
Enhance your docs with interactive components by combining the simplicity of Markdown with the power of JSX.
Write documentation wherever works best for you, seamlessly syncing between ReadMe and your Git repositories.
Platform Guides
Essential guides to help you set up and manage your ReadMe project.
Get started with configuration, initial setup, and launch preparations for your ReadMe project.
Organize and present your API documentation with MDX support, editing UI, reference materials, and Git syncing.
Enhance developer onboarding with personalized experiences, tutorials, and active community engagement.
Customize your documentation with design themes, branding, custom code, and third-party integrations.
Manage teams, billing, and security settings with ease through our integrated account management solutions.
Access FAQs, troubleshooting guides, upgrade instructions, and request new features for your ReadMe project.
Enterprise Guides
Advanced features and tools for enterprise-level ReadMe projects.
Manage and organize user groups with advanced permissions and access controls for enterprise-level operations.
Administer user accounts, roles, and permissions with enterprise-grade security and authentication options.
Automate and streamline your documentation processes with customizable workflows and approval systems.
Updated 3 days ago