Json To Readme API

POST https://api.findutils.com/api/tools/json-to-readme/execute

Generate a README.md (title, shields.io badges, description, demo/docs links, features, installation, usage, contributing, author, license) from JSON such as {"name","description","features":[...],"installation":[...],"license":"MIT"}. Returns the Markdown and the list of sections included.

Needs an API key. Running a tool needs an API key. Keys are not for sale yet: ask for early access. About API keys

Open the tool Try it

Request body

application/json

json

string required

README JSON: {"name": string, "description": string, "badges"?: [{"label","message","color"?}], "logo"?, "installation"?: string[], "usage"?, "features"?: string[], "contributing"?, "license"?, "author"?: {"name","github"?,"twitter"?,"website"?}, "demo"?, "documentation"?}.

Example arguments

Verified

{
  "json": {
    "name": "Awesome Project",
    "description": "A fast tool for developers.",
    "features": [
      "Fast"
    ],
    "installation": [
      "npm install awesome"
    ],
    "license": "MIT"
  }
}

curl -X POST https://api.findutils.com/api/tools/json-to-readme/execute \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "json": "{\"name\":\"Awesome Project\",\"description\":\"A fast tool for developers.\",\"features\":[\"Fast\"],\"installation\":[\"npm install awesome\"],\"license\":\"MIT\"}"
  }'

const response = await fetch('https://api.findutils.com/api/tools/json-to-readme/execute', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json', Authorization: 'Bearer YOUR_API_KEY' },
  body: JSON.stringify({"json":"{\"name\":\"Awesome Project\",\"description\":\"A fast tool for developers.\",\"features\":[\"Fast\"],\"installation\":[\"npm install awesome\"],\"license\":\"MIT\"}"}),
});
const data = await response.json();

import requests

response = requests.post(
    "https://api.findutils.com/api/tools/json-to-readme/execute",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"json":"{\"name\":\"Awesome Project\",\"description\":\"A fast tool for developers.\",\"features\":[\"Fast\"],\"installation\":[\"npm install awesome\"],\"license\":\"MIT\"}"},
)
data = response.json()

$ch = curl_init('https://api.findutils.com/api/tools/json-to-readme/execute');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json', 'Authorization: Bearer YOUR_API_KEY'],
    CURLOPT_POSTFIELDS => '{"json":"{\"name\":\"Awesome Project\",\"description\":\"A fast tool for developers.\",\"features\":[\"Fast\"],\"installation\":[\"npm install awesome\"],\"license\":\"MIT\"}"}',
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

Also an MCP tool

Call json_to_readme from Claude, Cursor or any MCP client. Same arguments, same output.

https://mcp.findutils.com

MCP reference

Rate limit: 60 a minute, per IP
Auth: API key
REST id: json-to-readme
MCP name: json_to_readme
Category: Generators
Machine-readable: openapi.json · markdown.md

Request body

Example arguments

More Generators tools

More to explore