Skip to content
BEAD

README.md Skeleton

Fill in project name, description, language, and license — emit a clean README with badges and a TOC.

GeneratorsText
Badges
README.md
# my-package

[![CI](https://github.com/you/my-package/actions/workflows/ci.yml/badge.svg)](https://github.com/you/my-package/actions/workflows/ci.yml) [![npm version](https://img.shields.io/npm/v/my-package)](https://www.npmjs.com/package/my-package) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](#license)

> A short, punchy description.

## Table of contents

- [Install](#install)
- [Usage](#usage)
- [API](#api)
- [Configuration](#configuration)
- [Contributing](#contributing)
- [License](#license)

## Install

```sh
npm install my-package
```

## Usage

```node
import { something } from "my-package";

const result = something({ /* options */ });
console.log(result);
```

## API

Document the public surface here — exported functions, classes, CLI flags.

## Configuration

Environment variables, config files, or runtime flags.

| Variable | Default | Description |
| --- | --- | --- |
| `EXAMPLE_VAR` | `42` | What it does |

## Contributing

Pull requests welcome. For major changes, open an issue first to discuss what you'd like to change.

## License

[MIT](LICENSE) © Your Name
</>Use this tool programmaticallycurl · JavaScript · MCP

Same tool, callable from any HTTP client or from Claude (via MCP). Anonymous: 100 req/day per IP. Sign up for 1,000 req/day.

curl
curl https://api.b-e-a-d.com/tools/readme-skeleton/run \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example",
  "description": "a",
  "lang": "node",
  "license": "MIT",
  "author": ""
}'
JavaScript (fetch)
const res = await fetch("https://api.b-e-a-d.com/tools/readme-skeleton/run", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
  "name": "example",
  "description": "a",
  "lang": "node",
  "license": "MIT",
  "author": ""
}),
});
const data = await res.json();
console.log(data.result);
MCP (Claude Desktop / Claude Code)
# In Claude Desktop / Claude Code, add to your MCP config:
{
  "mcpServers": {
    "bead": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://mcp.b-e-a-d.com"]
    }
  }
}

# Then ask Claude to call:
mcp__bead__bead_readme_skeleton

Full reference: developer docs · OpenAPI spec

What it gives you

A README structured the way readers actually scan it — title, badges, one-line description, the install command they came for, a minimal usage block, and the long-form sections collapsed into a TOC.

Customize after

The output is plain Markdown — tweak it freely. Badges link to shields.io with the values you typed.

You might also like