Skip to content

README.template.md

Latest commit

 

History

History
489 lines (368 loc) · 18.5 KB

README.template.md

File metadata and controls

489 lines (368 loc) · 18.5 KB
) before publishing

Auto-generated fields (see "Automation" section at the bottom): - CI badge → set up GitHub Actions workflow named ci.yml - Version badge → driven by npm/crates.io/PyPI/NuGet release - Coverage badge → Codecov integration - Changelog content → conventional commits + release tooling

═══════════════════════════════════════════════════════════════════ -->

{{PROJECT_NAME}} Banner

{{PROJECT_NAME}}

{{ONE_LINE_DESCRIPTION}}

CI npm version crates.io PyPI NuGet Coverage License: Apache-2.0 Total Stars

Table of Contents

Overview

{{PROJECT_NAME}} is a {{WHAT_IT_IS}} for the ResQ platform. It {{CORE_VALUE_PROPOSITION}}.

Related projects:

Repo Description
resq-software/resQ Core platform monorepo
resq-software/cli CLI tooling
resq-software/ui Shared component library
resq-software/mcp MCP server
resq-software/dotnet-sdk .NET SDK

Features

  • {{FEATURE_1}} — {{FEATURE_1_DESCRIPTION}}
  • {{FEATURE_2}} — {{FEATURE_2_DESCRIPTION}}
  • {{FEATURE_3}} — {{FEATURE_3_DESCRIPTION}}

Install

Node / Bun

bun add {{NPM_PACKAGE}}
# or: npm install {{NPM_PACKAGE}}

Peer dependencies:

bun add react@^19 react-dom@^19 tailwindcss@^4

Rust

cargo add {{CRATE_NAME}}

Python

uv add {{PYPI_PACKAGE}}
# or: pip install {{PYPI_PACKAGE}}

.NET

dotnet add package {{NUGET_PACKAGE}}

From source

git clone https://github.com/resq-software/{{REPO}}.git
cd {{REPO}}
{{BUILD_COMMAND}}

Quick Start

{{MINIMAL_WORKING_EXAMPLE}}

Usage

{{USE_CASE_1}}

{{EXAMPLE_1}}

{{USE_CASE_2}}

{{EXAMPLE_2}}

Full API reference: docs/ or resq.software/docs/{{REPO}}

Configuration

Variable / Flag Default Description
{{ENV_VAR_1}} {{DEFAULT_1}} {{DESCRIPTION_1}}
{{ENV_VAR_2}} {{DEFAULT_2}} {{DESCRIPTION_2}} 
{{CONFIG_EXAMPLE}}

Contributing

We welcome contributions. Please read CONTRIBUTING.md before opening a PR.

Local setup:

git clone https://github.com/resq-software/{{REPO}}.git
cd {{REPO}}
{{DEV_SETUP_COMMAND}}

Run tests:

{{TEST_COMMAND}}

Commit convention: This project uses Conventional Commits. All PRs must follow the type(scope): subject format — see the table below.

Prefix Effect on version
feat: Minor bump (0.x.0)
fix: / perf: Patch bump (0.0.x)
BREAKING CHANGE footer or ! suffix Major bump (x.0.0)
docs: style: refactor: test: chore: No version bump

Changelog

See CHANGELOG.md for the full release history.

License

Copyright 2026 ResQ

Licensed under the Apache License, Version 2.0.