generated from MrSphay/codex-agent-repository-kit
77 lines
1.6 KiB
Markdown
77 lines
1.6 KiB
Markdown
{{ template:title }}
|
|
|
|
{{ template:badges }}
|
|
|
|
{{ template:section-line }}
|
|
{{ template:table-of-contents }}
|
|
|
|
{{ template:section-line }}
|
|
## Overview
|
|
|
|
PROJECT_DESCRIPTION
|
|
|
|
{{ template:section-line }}
|
|
## Features
|
|
|
|
| Area | Description |
|
|
| --- | --- |
|
|
| Core | Describe the main project capability |
|
|
| Workflow | Describe the primary user or developer workflow |
|
|
| Build | Describe how artifacts are produced |
|
|
| Security | Describe the default security posture |
|
|
|
|
{{ template:section-line }}
|
|
## Installation
|
|
|
|
```bash
|
|
INSTALL_COMMAND
|
|
```
|
|
|
|
{{ template:section-line }}
|
|
## Development
|
|
|
|
```bash
|
|
DEV_COMMAND
|
|
LINT_COMMAND
|
|
TEST_COMMAND
|
|
BUILD_COMMAND
|
|
```
|
|
|
|
{{ template:section-line }}
|
|
## Downloads
|
|
|
|
| Variant | Download |
|
|
| --- | --- |
|
|
| Latest artifact | [Download latest](DOWNLOAD_URL) |
|
|
|
|
Private repositories may require an active session or a token with package read access.
|
|
|
|
{{ template:section-line }}
|
|
## Security
|
|
|
|
Security posture:
|
|
|
|
| Area | State |
|
|
| --- | --- |
|
|
| Secrets | Secrets must not be committed |
|
|
| Dependency audit | CI should run the project dependency audit |
|
|
| User data | User data should stay local unless explicitly documented |
|
|
| External services | Network calls should be documented |
|
|
|
|
See `SECURITY.md` and `docs/security-review.md`.
|
|
|
|
{{ template:section-line }}
|
|
## Release
|
|
|
|
Release readiness is tracked in `docs/release-checklist.md`.
|
|
|
|
{{ template:section-line }}
|
|
## Project Info
|
|
|
|
| Field | Value |
|
|
| --- | --- |
|
|
| Author | `AUTHOR_NAME` |
|
|
| Repository | `REPOSITORY_OWNER/REPOSITORY_NAME` |
|
|
| Stack | `PROJECT_STACK` |
|
|
| README workflow | Blueprint workflow based on `andreasbm/readme` |
|