README 的安装与用法部分怎么写才清楚

更新于 2026-08-30 · AI README 生成器

「安装」和「用法」是 README 被复制最多的部分,写清楚能挡掉一半 Issue。

安装:只给必要命令

# npm
npm install your-pkg
# 或 pnpm
pnpm add your-pkg

别在这里讲完整配置,留到用法里。

用法:最小可运行

import pkg from "your-pkg";
const r = pkg({ /* 最小配置 */ });
console.log(r);

目标:访客复制这段代码,装完依赖就能跑,看到预期输出。

常见坑提示

把命令和示例填进工具的对应字段,生成时自动包进代码块。

立即使用 AI README 生成器 →