What's new in ReadMe

Here's quick roundup of some of our newest features!

User Connect

Get your users (and their API keys!) into ReadMe! Now with just minimal setup, you can bring your users into ReadMe and include their unique information directly in the documentation! By telling us a little bit about them when they log in, you can embed their information directly into pages, and the API Explorer.

If you have OAuth2 set up already, we have a connector for it. Otherwise, it's easy to generate JWT tokens that magically log your users in. (Read our full announcement)

How to use it: It's in your account, under User Connect.

Combined Projects beta

Sometimes, your project is more complex than just one "developer hub", and you want to combine multiple projects into one. Your users will be able to switch between projects, search across all combined projects, and share content.

How to use it: Request a demo on our Enterprise page

Glossary

Sometimes you want to call out specific words or phrases, and give people more information about them in a popup.

How to use it: It's in your account, under General Settings > Glossary

Health Check

When their integration breaks, the first thing your users will do is go to their docs! Our new Health Check feature will allow you to alert you users to issues with your API. It can be integrated with StatusPage, so you just have to update the status in one place.

How to use it: It's on your account, under General Settings > Health Check

Metrics beta

Who's using your API docs, and how are they using it? We've been building out a robust metrics system, so you can see things like who finds your pages useful, what they're visiting, what companies they're coming from, and more.

How to use it: It's currently in beta, however you can request a demo

Command line tool (rdme)

If you want to integrate Swagger / OpenAPI uploads directly into your build process, you can use our rdme command line tool. We just rebuilt it, so it's easy to upload your Swagger file directly to ReadMe.

To install, type npm i rdme -g. To upload a file, run rdme swagger {path-to-swagger.json} --token={api-key}.

Here's rdme on npm.

How to use it: Go into Reference Docs > Add another API, and choose Swagger

API beta

We're an API company… it's about time we had an API! Right now, we have one public endpoint, which lets you upload a Swagger file programatically. We use it ourselves for the rdme command line tool.

We're beta-testing the ability to create or update documentation. So, you'll be able to automate content on a page, or do stuff like sync everything from GitHub.

How to use it: For the Swagger upload, go to General Settings > API Key. For editing pages, you can request a demo

Translations beta

Avoir une audience mondiale? We now have deep integrations with some third-party services (Localize and Transifex) that let you translate content. Don't limit your docs just to developers who know English!

How to use it: It's currently in beta, however you can request a demo

Other Enhancements

  • Bing verification You can now verify your site via Bing's webmaster tools (General Settings > Integrations)
  • GDPR Compliance Page Track our GDPR compliance on our GDPR Information page
  • Feature requests We now have a public place to request features, so post new ideas or vote on ones you like

Need Beautiful API Documentation?

ReadMe makes it easy to create amazing documentation in minutes!

Sign Up Now