SkillsAdd

motormetrics/motormetrics

readme-updates

Maintain README files with setup instructions, features, tech stack, and usage examples. Use when updating project documentation, adding new features, improving onboarding, or creating READMEs for new packages.

First seen Jan 22, 2026

Installation

$ npx skills add motormetrics/motormetrics --skill readme-updates
View on skills.sh ↗ GitHub repository ↗

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

azure-ai Same topic
microsoft/azure-skills

Use for Azure AI: Search, Speech, OpenAI, Document Intelligence. Helps with search, vector/hybr…

568.2K installs
azure-rbac Same topic
microsoft/azure-skills 489K installs
pptx Same topic
anthropics/skills

Use this skill any time a .pptx or .potx file is involved in any way — as input, output, or bot…

216.8K installs
pdf Same topic
anthropics/skills

Use this skill whenever the user wants to do anything with PDF files. This includes reading or …

192.4K installs
docx Same topic
anthropics/skills

Use this skill whenever the user wants to create, read, edit, or manipulate Word documents (.do…

184.5K installs
xlsx Same topic
anthropics/skills

Use this skill any time a spreadsheet file is the primary input or output. This means any task …

165K installs

Also in this package

Other skills from motormetrics/motormetrics · top by installs.

npx skills add motormetrics/motormetrics
framer-motion-animations 94 shadcn-components 83 code-review 79 api-testing 79 design-language-system 74 chart-implementation 69 performance 66 tailwind-config 65 deployment-rollback 65 data-seeding 60

Browse all from motormetrics/motormetrics

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Declared
Cline Not declared
OpenCode Not declared

Also listed on

Alternate registries and mirrors of this skill.

Repository health

Stars 22
License LICENSE
Default branch main
Open issues 42
Status Active

Skill metadata

Parsed from SKILL.md frontmatter.

Allowed toolsRead, Edit, Write, Bash, Grep, Glob
Declared agents gemini

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 3,676 B
  • docs SUMMARY.md 232 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 66 installs

SKILL.md

README Updates Skill

Root README Structure

# 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

Package README Template

# @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

Common Badges

[![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 Section

## 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
\`\`\`

Update Checklist

  • Features list current when new features added
  • Tech stack updated when dependencies change
  • Setup instructions accurate when process changes
  • Examples working and up-to-date
  • Links not broken

Validate README

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

# Lint markdown
pnpm dlx markdownlint README.md

Best Practices

  1. Clear Description: Concise project description at top
  2. Quick Start: Immediate value with copy-paste setup
  3. Working Examples: Test all code examples
  4. Keep Updated: Update when features change
  5. Check Links: Regularly verify links work

References