Back to Details

readme-updates

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

README Updates Skill

README更新Skill

Root README Structure

根目录README文件结构

markdown
undefined
markdown
undefined

SG Cars Trends

SG Cars Trends

License CI
Platform for accessing Singapore vehicle registration and COE bidding data
License CI
新加坡车辆注册及COE投标数据查询平台

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
  • 📊 全面数据：车辆注册及COE投标数据
  • 🔄 实时更新：自动从LTA DataMall每日更新数据
  • 📝 AI生成博客：使用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 ```
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, Recharts, Tailwind CSS
  • Backend: Drizzle ORM, PostgreSQL, Upstash Redis
  • Infrastructure: Vercel
  • AI: Google Gemini, Vercel AI SDK
  • 前端：Next.js 16, HeroUI, Recharts, Tailwind CSS
  • 后端：Drizzle ORM, PostgreSQL, Upstash Redis
  • 基础设施：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 ```
sgcarstrends/
├── apps/
│   ├── api/          # Hono API
│   └── web/          # Next.js web应用
├── packages/
│   ├── database/     # Drizzle数据模型
│   ├── ui/           # UI组件
│   └── utils/        # 共享工具函数

Development

开发流程

```bash pnpm dev # Start all servers pnpm test # Run tests pnpm build # Build for production ```
bash
pnpm dev          # 启动所有服务
pnpm test         # 运行测试
pnpm build        # 构建生产版本

License

许可证

MIT
undefined
MIT
undefined

Package README Template

包README文件模板

markdown
undefined
markdown
undefined

@sgcarstrends/[package-name]

@sgcarstrends/[package-name]

Brief description
简短描述

Installation

安装步骤

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

Usage

使用示例

```typescript import { functionName } from "@sgcarstrends/[package-name]";
const result = functionName(); ```
typescript
import { functionName } from "@sgcarstrends/[package-name]";

const result = functionName();

API

API说明

functionName(param: string): ReturnType

functionName(param: string): ReturnType

Description.
Parameters: 
param
(string) - Description
Returns: 
ReturnType
- Description
说明：
参数： 
param
（字符串）- 参数描述
返回值： 
ReturnType
- 返回值描述

Development

开发流程

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

License

许可证

MIT
undefined
MIT
undefined

Common Badges

常用徽章

markdown
[![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)
markdown
[![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

环境变量部分

markdown
undefined
markdown
undefined

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 ```
undefined
从
.env.example
创建
.env
文件：
env
DATABASE_URL=postgresql://user:pass@localhost:5432/db
UPSTASH_REDIS_REST_URL=https://your-redis.upstash.io
UPSTASH_REDIS_REST_TOKEN=your-token
undefined

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

README验证

bash
undefined
bash
undefined

Check for broken links

检查失效链接

pnpm dlx markdown-link-check README.md
pnpm dlx markdown-link-check README.md

Lint markdown

检查Markdown格式

pnpm dlx markdownlint README.md
undefined
pnpm dlx markdownlint README.md
undefined

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
  1. 清晰描述：在顶部放置简洁的项目描述
  2. 快速开始：提供可直接复制粘贴的设置步骤，快速体现价值
  3. 可用示例：测试所有代码示例确保可用
  4. 持续更新：功能变更时及时更新文档
  5. 检查链接：定期验证链接有效性

References

参考资料