ReadMe

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

Two-Factor Authentication

Highly Recommended

ReadMe strongly recommends enabling two-factor authentication (2FA) for an additional layer of security on your account.

ReadMe supports two-factor authentication (2FA). When logging into ReadMe with 2FA enabled on your account, you'll be required to enter a code from an authenticator app in addition to your password. We support any authenticator app that uses the TOTP (time-based one-time password) algorithm.

Enabling Two-Factor Authentication

To enable 2FA, navigate to the profile settings, locate the Two Factor Auth section, click Enable, and follow the instructions.

Backup Codes

When setting up 2FA, you'll be prompted to save 10 backup codes. These one-time use backup codes can be used to log you into ReadMe if you are unable to access 6-digit codes from your authenticator app.

Keep your backup codes safe!

Remember that these backup codes are one-time use - so if you just a few (or zero) remaining, you can generate new ones in the profile settings by clicking the View Backup Codes button. Generating new backup codes will invalidate your old ones!

If you cannot access your authenticator app and lost your backup codes, please contact us at [email protected].

Recommended Authenticator Apps

We recommend 1Password, which allows you to access one-time passwords via a web browser extension and desktop and mobile applications.

Other recommended apps include Google Authenticator, Microsoft Authenticator, LastPass, and Authy.


Two-Factor Authentication


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.