Project Name

One-line description of what this project does and who it is for.

Features

• Feature one – what it does and why it matters
• Feature two
• Feature three

Quick start

git clone https://github.com/you/project.git
cd project
npm install
npm run dev

Usage

import {thing} from 'project';

const result = thing.do('example');

Configuration

Option	Type	Default	Description
port	number	3000	Port to listen on
debug	boolean	false	Enable debug logging

Architecture

flowchart LR
    Client --> API[API layer]
    API --> Core[Core logic]
    Core --> DB[(Storage)]

Contributing

See CONTRIBUTING.md. Pull requests welcome.

License

MIT – see LICENSE.