Skip to content

README.template.md

Latest commit

 

History

History
583 lines (427 loc) · 22.1 KB

README.template.md

File metadata and controls

583 lines (427 loc) · 22.1 KB
Raw
{{PROJECT_NAME}}

{{PROJECT_NAME}}

{{ONE_LINE_DESCRIPTION}}

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

Documentation  ·  Website  ·  Quick Start  ·  Report Bug  ·  Request Feature

◆   ◆   ◆

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

Demo

{{PROJECT_NAME}} demo

Try it live: {{LIVE_DEMO_URL}} · Playground

Features

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

Prerequisites

Requirement Minimum Notes
{{RUNTIME}} {{MIN_VERSION}} {{RUNTIME_NOTE}}
Platform Linux / macOS / Windows {{PLATFORM_NOTE}}

Install

ResQ CLI

Install the resq toolchain (and, when run inside a repo, the canonical git hooks) in one line:

curl -fsSL https://get.resq.software | sh

Prefer to read before piping to a shell:

curl -fsSL https://get.resq.software -o install-resq.sh
less install-resq.sh
sh install-resq.sh

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

CI gate: every PR must keep the required status check green (org ruleset default-branch-baseline). That single check aggregates language CI, the security scan, and repo-standards conformance — see resq-software/.github.

Security

Found a vulnerability? Do not open a public issue. Follow the coordinated-disclosure process in SECURITY.md (inherited org-wide from resq-software/.github).

This project ships SHA-pinned CI actions and is scanned for vulnerable dependencies and leaked secrets on every push.

Support

Changelog

See CHANGELOG.md for the full release history.

License

Copyright 2026 ResQ

Licensed under the Apache License, Version 2.0.

Acknowledgements

Stats