Project name
A precise one-sentence value proposition for the people who will use this project.
Website ·
Documentation ·
npm ·
Releases ·
Issues
Project name helps **target audience** achieve **primary outcome** without **important pain point**.
Explain the scope, differentiator, and maturity in two or three concrete sentences.
## Why Project name
- **Outcome one** — explain the user benefit, not only the implementation.
- **Outcome two** — make an important differentiator easy to scan.
- **Predictable by default** — state a trust, safety, performance, or compatibility property.
## Install
```bash
pnpm add package-name
```
## Quick start
```ts
import { createThing } from 'package-name'
const result = createThing({ input: 'value' })
console.log(result)
```
Explain what the example returns or changes. Link to the
[complete getting-started guide](https://docs.example.com/getting-started) for configuration and
framework-specific usage.
## Packages
| Package | Purpose | Documentation |
| ------------------------------------------------------------ | -------------------- | ------------------------------------------------------- |
| [`package-name`](https://www.npmjs.com/package/package-name) | Primary public API | [API reference](https://docs.example.com/api) |
| [`adapter-name`](https://www.npmjs.com/package/adapter-name) | Optional integration | [Adapter guide](https://docs.example.com/adapters/name) |
## Compatibility
State supported runtimes, frameworks, operating systems, browsers, or editor versions. Mark beta
surfaces and breaking-change expectations explicitly.
## Documentation
- [Getting started](https://docs.example.com/getting-started)
- [Configuration](https://docs.example.com/configuration)
- [API reference](https://docs.example.com/api)
- [Examples](https://docs.example.com/examples)
- [Changelog](CHANGELOG.md)
## Development
```bash
pnpm install
pnpm dev
pnpm test
pnpm check
```
Describe the repository-specific validation command and any required local services. Keep user
installation above separate from contributor setup.
## Contributing
Read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request. Link to the issue tracker,
explain whether user-visible changes need a changeset, and identify the code of conduct when one
exists.
## Security
Report vulnerabilities through the private process in [SECURITY.md](SECURITY.md). Do not ask users
to disclose security issues in a public issue.
## License
MIT. See [LICENSE](LICENSE).