写 README #

# 项目名称

简短描述项目功能。

[![npm](https://img.shields.io/npm/v/package)](https://npmjs.com/package/package)
[![license](https://img.shields.io/npm/l/package)](./LICENSE)
[![build](https://img.shields.io/github/actions/workflow/status/user/repo/ci.yml)](https://github.com/user/repo/actions)

## 目录

- [功能特性](#功能特性)
- [安装](#安装)
- [快速开始](#快速开始)
- [文档](#文档)
- [贡献](#贡献)
- [许可证](#许可证)

## 功能特性

- 特性一
- 特性二
- 特性三

## 安装

```bash
npm install package-name

import { hello } from 'package-name';

hello('World');

## 各部分详解

### 标题和徽章

```markdown
# 项目名称

一句话描述。

<p align="center">
  <img src="logo.png" width="200">
</p>

<p align="center">
  <a href="https://npmjs.com/package/package">
    <img src="https://img.shields.io/npm/v/package" alt="npm version">
  </a>
  <a href="./LICENSE">
    <img src="https://img.shields.io/npm/l/package" alt="license">
  </a>
  <a href="https://github.com/user/repo/actions">
    <img src="https://img.shields.io/github/actions/workflow/status/user/repo/ci.yml" alt="build status">
  </a>
</p>

## 功能特性

- 🚀 **高性能** - 毫秒级响应
- 🔧 **易配置** - 零配置开箱即用
- 📦 **轻量级** - 仅 5KB gzipped
- 🔒 **类型安全** - 完整 TypeScript 支持
- 🌐 **跨平台** - 支持浏览器和 Node.js

## 安装

### 包管理器

```bash
# npm
npm install package-name

# yarn
yarn add package-name

# pnpm
pnpm add package-name

<script src="https://unpkg.com/package-name"></script>

### 快速开始

```markdown
## 快速开始

### Hello World

```javascript
import { hello } from 'package-name';

console.log(hello('World'));
// 输出: Hello, World!

### 截图演示

```markdown
## 截图

<p align="center">
  <img src="screenshot.png" width="600">
</p>

## 文档

- [快速开始](./docs/getting-started.md)
- [API 文档](./docs/api.md)
- [配置选项](./docs/configuration.md)
- [常见问题](./docs/faq.md)

## 贡献

欢迎贡献！

1. Fork 本仓库
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 创建 Pull Request

详见 [贡献指南](./CONTRIBUTING.md)

## 许可证

[MIT](./LICENSE) © Your Name

# library-name

简短描述。

## 安装

```bash
npm install library-name

import { func } from 'library-name';

func();

### 应用模板

```markdown
# app-name

应用描述。

## 截图

![截图](screenshot.png)

## 功能

- 功能一
- 功能二

## 安装

```bash
git clone https://github.com/user/app.git
cd app
npm install
npm start

### 工具模板

```markdown
# tool-name

工具描述。

## 安装

```bash
npm install -g tool-name

tool-name [options]

## 最佳实践

### 1. 保持简洁

```markdown
好的：
一句话描述项目功能

不好的：
冗长的背景介绍...

好的：
[![npm](https://img.shields.io/npm/v/package)](https://npmjs.com/package/package)

不好的：
无徽章

好的：
```javascript
import { hello } from 'package';
hello('World');

### 4. 包含截图

```markdown
好的：
![截图](screenshot.png)

不好的：
无截图

好的：
文档与代码同步更新

不好的：
文档过时