Project README template

Badges, features, install, usage, license. Open it in the editor, replace what needs replacing, and export a typeset PDF — free, no signup, nothing uploaded.

Use this template All templates

Preview

Project Name

One-line description of what this project does.

✨ Features

Fast and lightweight
Fully typed
Plugin system

🚀 Installation

bash

npm install project-name

📖 Usage

typescript

import { thing } from 'project-name'

thing.doSomething()

🤝 Contributing

Pull requests are welcome. For major changes, please open an issue first.

📝 License

MIT

The Markdown source

---
title: Project Name
author: Your Name
---

# Project Name

> One-line description of what this project does.

## ✨ Features

- [x] Fast and lightweight
- [x] Fully typed
- [ ] Plugin system

## 🚀 Installation

```bash
npm install project-name
```

## 📖 Usage

```typescript
import { thing } from 'project-name'

thing.doSomething()
```

## 🤝 Contributing

Pull requests are welcome. For major changes, please open an issue first.

## 📝 License

[MIT](https://choosealicense.com/licenses/mit/)

Copy it anywhere Markdown works — or open it pre-loaded in Scripto with the button above.