Introducing Recipes

Highlight your top API use cases with interactive, step-by-step walkthroughs.

📖Sync Directory of Files via Code
1const fs = require('fs');
2const sdk = require('api')('[email protected]');
3
4sdk.auth("USER");
5
6const categories = await sdk
7  .getCategories({ perPage: "10", page: "1" })
8  .then((res) => res.json());
9
10const docs = fs.readDirSync("./docs");
11
12for (const doc of docs) {
13  const docContent = fs.readFileSync(doc);
14
15  sdk
16    .createDoc({
17      title: doc,
18      body: docContent,
19      category: categories[0]._id,
20    })
21    .then((res) => res.json())
22    .then((res) => {
23      console.log(res);
24    });
25}

Show don’t tell. One step at a time.

Walk users through success using your service. Sequence written instructions with code samples in a user-driven, unified learning environment

Tutorial steps showing how to sync files with ReadMeReadMe LogoSee more in our docs!

Embed guidance in the right place at the right time.

Add Recipes directly to your docs to point developers in the right direction — whenever they're ready.

Make an impression (and have some fun).

Match Recipes to the look and feel of your ReadMe docs. Give each one its own emoji for a little extra whimsy.

Capture transactions after 1 hour.
Finalize transactions after a 1 hour grace period to allow for cancellations.
3 Steps
Capture transactions after 1 hour.
Open Recipe

Your API shines where it matters.

Make static documentation a thing of the past. Guide users through complex use cases by highlighting relevant code as you describe each step.

1const sdk = require('api')('[email protected]');
2
3sdk.applyToReadMe({
4 name: 'Your Name',
5 email: '[email protected]',
6 job: 'API Engineer',
7 dontReallyApply: false
8})
9 .then(res => res.json())
10 .then(res => {
11 console.log(res);
12 });
Four tutorial cards

Give developers a head start.

Share solutions for popular use cases to help them start building quickly.

Steps next to their code

It's like show and tell for APIs.

Support developers with step-by-step guidance from start to finish.

Learn more about ReadMe

Beautiful, personalized and interactive developer hubs