2 min read
README
When you want to share a project — on GitHub, in a portfolio, or with collaborators — a good README explains what it is, how to run it, and what it looks like. Copy this template into a README.md file in your project root.
The Template
# [Project Name]
[One-line description of what this project does.]
## Screenshot
## What It Does
[2-3 sentences describing the project. What problem does it solve? Who is it for?]
## Built With
- [Platform: web / macOS / iOS]
- [Framework or language]
- [Any key libraries or APIs]
## Getting Started
### Prerequisites
- [What someone needs installed to run this]
### Run Locally
```bash
[commands to clone and run the project]
```
## Features
- [Feature 1]
- [Feature 2]
- [Feature 3]
## Acknowledgments
- Built with [Claude Code](https://claude.ai/claude-code)
- [Any other credits]Example — Filled In
# Weather Dashboard
A minimal weather dashboard that shows current conditions and a 7-day forecast for any city.
## Screenshot
## What It Does
Weather Dashboard lets you search for any city and see real-time weather data — current temperature, conditions, and a week-long forecast. It's a fast, single-page app with no account required. Built as a personal project to learn API integration with Claude Code.
## Built With
- Web (single-page app)
- React + TypeScript
- Open-Meteo API (free, no API key required)
## Getting Started
### Prerequisites
- Node.js 18 or later
### Run Locally
```bash
git clone https://github.com/yourname/weather-dashboard.git
cd weather-dashboard
npm install
npm run dev
```
Then open [http://localhost:5173](http://localhost:5173) in your browser.
## Features
- Search by city name with autocomplete
- Current temperature, humidity, and wind speed
- 7-day forecast with high/low temperatures
- Responsive layout that works on mobile
## Acknowledgments
- Built with [Claude Code](https://claude.ai/claude-code)
- Weather data from [Open-Meteo](https://open-meteo.com/)Tips
- A screenshot is worth a thousand words — always include one.
- Keep it short — people scan READMEs, they don’t read them.
- You can ask Claude: “Write a README for this project based on what we’ve built.”