mcpField
R
readme-updates

readme-updates

github.com/motormetrics开发2267 次安装今天更新
代码仓库

关于 readme-updates

用于维护项目根目录和软件包 README 的写作指南，提供结构模板、更新检查项及链接和 Markdown 校验命令。适合需要让项目说明保持准确、完整的维护者。

主要功能

  1. 01提供根目录 README 结构示例
  2. 02提供软件包 README 模板
  3. 03列出常见徽章和环境变量章节
  4. 04包含更新检查清单
  5. 05说明链接和 Markdown 校验方法

适用场景

  1. 01为新软件包编写 README
  2. 02更新项目功能或技术栈说明
  3. 03核对安装步骤和代码示例
  4. 04检查 Markdown 格式与链接

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/motormetrics/motormetrics --skill readme-updates

安装后在 Claude Code 中输入/readme-updates确认已加载。

详细介绍

README 更新技能

根目录 README 结构

# SG Cars Trends

[![License](https://img.shields.io/github/license/sgcarstrends/sgcarstrends)](LICENSE)
[![CI](https://github.com/sgcarstrends/sgcarstrends/workflows/CI/badge.svg)](https://github.com/sgcarstrends/sgcarstrends/actions)

> Platform for accessing Singapore vehicle registration and COE bidding data

## Features

- 📊 **Comprehensive Data**: Car registration and COE bidding data
- 🔄 **Real-time Updates**: Automated daily updates from LTA DataMall
- 📝 **AI-Generated Blog**: Automated insights using Google Gemini

## Quick Start

\`\`\`bash
git clone https://github.com/sgcarstrends/sgcarstrends.git
cd sgcarstrends
pnpm install
cp .env.example .env
pnpm db:migrate
pnpm dev
\`\`\`

## Tech Stack

- **Frontend**: Next.js 16, HeroUI v3 (+ HeroUI Pro), Tailwind CSS v4
- **Backend**: Drizzle ORM, PostgreSQL, Upstash Redis
- **Infrastructure**: Vercel
- **AI**: Google Gemini, Vercel AI SDK

## Project Structure

\`\`\`
sgcarstrends/
├── apps/
│   ├── api/          # Hono API
│   └── web/          # Next.js web app
├── packages/
│   ├── database/     # Drizzle schemas
│   ├── ui/           # UI components
│   └── utils/        # Shared utilities
\`\`\`

## Development

\`\`\`bash
pnpm dev          # Start all servers
pnpm test         # Run tests
pnpm build        # Build for production
\`\`\`

## License

MIT

软件包 README 模板

# @sgcarstrends/[package-name]

> Brief description

## Installation

\`\`\`bash
pnpm add @sgcarstrends/[package-name]
\`\`\`

## Usage

\`\`\`typescript
import { functionName } from "@sgcarstrends/[package-name]";

const result = functionName();
\`\`\`

## API

### `functionName(param: string): ReturnType`

Description.

**Parameters:** `param` (string) - Description

**Returns:** `ReturnType` - Description

## Development

\`\`\`bash
pnpm test
pnpm build
\`\`\`

## License

MIT

常用徽章

[![License](https://img.shields.io/github/license/user/repo)](LICENSE)
[![CI](https://github.com/user/repo/workflows/CI/badge.svg)](actions)
[![npm](https://img.shields.io/npm/v/@sgcarstrends/package)](npm)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue)](typescript)

环境变量部分

## Environment Variables

Create `.env` from `.env.example`:

\`\`\`env
DATABASE_URL=postgresql://user:pass@localhost:5432/db
UPSTASH_REDIS_REST_URL=https://your-redis.upstash.io
UPSTASH_REDIS_REST_TOKEN=your-token
\`\`\`

更新检查清单

  • 添加新功能时，更新功能列表
  • 依赖项变更时，更新技术栈
  • 流程变更时，确保设置说明准确
  • 确保示例可正常运行且内容为最新
  • 确保链接有效

验证 README

# Check for broken links
pnpm dlx markdown-link-check README.md

# Lint markdown
pnpm dlx markdownlint README.md

最佳实践

  1. 清晰的描述：在顶部简洁介绍项目
  2. 快速开始：提供可立即复制粘贴的设置说明
  3. 可运行的示例：测试所有代码示例
  4. 保持更新：功能变更时及时更新
  5. 检查链接：定期确认链接有效

参考资料

评论

支持 Markdown