Connect your ReadMe account

You now have the ability to connect your ReadMe projects and instantly search API documentation and guides, along with your others sources, like Slack, Google Docs, Jira, Confluence, and more, directly within Traitly. 

Here is a step-by-step guide for connecting your ReadMe account:

1. Navigate to the ReadMe integration section within the integrations category by clicking here.

2. Click on the "Connect Project" button. This will bring you to a section where you will enter the credentials for the project being connected to Traitly:

Give the project a name and enter the domain and API key. You should enter the domain as it appears in your ReadMe documentation, e.g., https://traitly-test.readme.io/v1.0/reference. 

You will find your API key in the "Project Dashboard" section of your ReadMe project. You must enter the credentials separately for each project you wish to connect to Traitly. Your ReadMe account can be used to power more than one project. 

 

3. In Traitly, click the "Test connection" button before saving to ensure that your ReadMe project has been successfully connected. 

4. Traitly will automatically import your docs within 24 hours.