A README that people actually read

Markdown

The order matters more than the length: what it is, how to run it, how to develop on it.

# Project name

One sentence on what this does and who it is for.

## Running it

```bash
cp .env.example .env
npm install
npm start
```

## Developing

| Command | What it does |
| --- | --- |
| `npm start` | Build the CSS and run the server |
| `npm run watch:css` | Rebuild the stylesheet on change |

Download

Data Formats markdown docs readme chris

More in Data Formats

A minimal JSON Schema Data Formats Describes the shape of a payload so it can be validated before anything else touches it. An RSS feed skeleton Data Formats The minimum a reader needs. Dates must be RFC 822, which is the part most generators get wrong. YAML anchors to avoid repeating yourself Data Formats Define a block once, merge it into each service. Changing the base changes all of them.

Random picks

Which indexes is nobody using? Databases Lists indexes that have never been scanned, which are pure write cost. Check against a long uptime before dropping any. Fetch with a timeout JavaScript fetch has no timeout of its own. AbortSignal.timeout is the short way to give it one. RAII file handling in C++ Systems The stream closes itself when it leaves scope, whether the function returns normally or throws. Amend a commit without changing its message Git Adds forgotten files to the previous commit and leaves the message exactly as it was. Which DNS records does a domain have? Networking dig with +short strips everything but the answer. Remove every stopped container and dangling image Containers Reclaims disk after a week of building. The volume flag is separate because it is the one that loses data. Call a JSON API from PowerShell Networking Invoke-RestMethod parses the response for you, so no ConvertFrom-Json step is needed. Multi-stage Dockerfile for a Node service Containers Builds with the full toolchain, ships only production dependencies, and runs as a non-root user.