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. 04Markdown形式とリンクの検証

インストール

コマンドをコピーしてターミナルで実行します。

$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 対応