Standard Plugin Template¶

Purpose: Standardization of Plugin Documentation. Applies To: All structum-* plugins.

Every plugin MUST have a README.md at its package root (packages/<plugin>/README.md). This file serves as the landing page for PyPI and GitHub.

Template Structure¶

Copy and adapt the following structure.

# Structum [Plugin Name]

[![PyPI version](https://img.shields.io/pypi/v/structum-[name].svg)](https://pypi.org/project/structum-[name]/)
[![AI Governance](https://img.shields.io/badge/AI--Assisted-Human--Governed-black)](https://structum.pages.dev/governance/ai_assisted)

**One-line description of what this plugin does.**

---

## Status

| Feature | Details |
| :--- | :--- |
| **Package** | `structum-[name]` |
| **Namespace** | `structum.plugins.[name]` |
| **Status** | Alpha/Beta/Stable |

---

## 1. Overview

Why does this plugin exist? What problem does it solve?

## 2. Installation

\`\`\`bash
pip install structum-[name]
\`\`\`

## 3. Usage

\`\`\`python
from structum.plugins.[name] import Plugin
# Code example
\`\`\`

## 4. Configuration

Describe TOML/Env configuration options.

## 5. AI Governance

> **AI-Assisted Development**
> This plugin observes the Structum AI Governance model.
> AI agents are used for auditing and documentation.
> **Final design authority remains human.**

## 6. Constitution Compliance

| Article | Status | Notes |
| :--- | :--- | :--- |
| **C-1 Optionality** | ✅ | Can be disabled via config. |
| **C-4 Zero Lock-In** | ✅ | Uses standard interfaces. |