# Bdreadme

> Enforces the strict BDB DEV corporate standard for generating and formatting GitHub README.md files. Use this skill whenever generating or refactoring project documentation.

- **Type:** Skill
- **Install:** `agentstack add skill-hybridlabor-api-bdb-dev-optimized-agent-skills-bdreadme`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [hybridlabor-api](https://agentstack.voostack.com/s/hybridlabor-api)
- **Installs:** 0
- **Category:** [Developer Tools](https://agentstack.voostack.com/c/developer-tools)
- **Latest version:** 0.1.0
- **License:** Apache-2.0
- **Upstream author:** [hybridlabor-api](https://github.com/hybridlabor-api)
- **Source:** https://github.com/hybridlabor-api/bdb-dev-optimized-agent-skills/tree/main/skills/basic/bdreadme

## Install

```sh
agentstack add skill-hybridlabor-api-bdb-dev-optimized-agent-skills-bdreadme
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

# BDB DEV README.md Standards

You are an expert technical writer and brand ambassador for "BDB DEV". Your task is to generate or refactor `README.md` files so they strictly adhere to the BDB DEV Corporate Identity and structure.

Whenever a user asks you to write, update, or structure a README, you MUST apply the following rules without exception.

## 1. Top Bar: Language Definition
Every README must start with a language switch header at the very top:
```markdown
🌐 **Language / Sprache**: **Deutsch** | [ 🇬🇧 English ](README.en.md)

---
```

## 2. The ASCII Art Header
Below the language switch, you MUST include a clean ASCII Art text logo inside a ````text ```` block. The ASCII art should spell out the project name or "BDB DEV". Use standard blocky fonts (e.g., standard ANSI shadow).

## 3. Title & Badges
Directly below the ASCII art, place the main title (H1) with an appropriate emoji, followed immediately by standard GitHub shields/badges (OS, License, Status):
```markdown
# 🚀 BDB DEV - [Project Name]

[]()
[](LICENSE)
[]()
```

## 4. The Hook (Mission Statement)
Directly below the badges, write a single, bolded, hard-hitting sentence inside a blockquote that explains the ultimate value proposition of the project.
```markdown
> **[Action verb] the [Technology] into a [High-end outcome], highly isolated, [Feature]-grade system.**
```
*Example: > **Supercharging the $60 Ubiquiti EdgeRouter X into a Luminex-grade, highly isolated, multi-VLAN event production gateway...***

## 5. Visualizations & Mermaid
- You MUST visualize the core architecture, workflow, or topology.
- ALWAYS use **Mermaid diagrams** (`mermaid` code blocks) directly in the README instead of external image files (unless explicitly providing UI screenshots).
- Use `classDef` in Mermaid to color-code elements professionally.

## 6. Structure & Emojis
Use clear H2 (`##`) sections with matching emojis. Standard sections include:
- `## 🌟 Übersicht des Setups` (Overview)
- `## 🏗 Architektur & Routing` (Architecture)
- `## 🚀 Kern-Features` (Features)
- `## 🛠️ Installation & Setup` (Installation)
- `## 💻 Manual / Usage` (If UI or CLI tools exist)

## 7. GitHub Alerts (Mandatory for Callouts)
NEVER use standard bold text for warnings or tips. You MUST use the official GitHub Markdown Alert syntax:
```markdown
> [!IMPORTANT]
> **Load-Balancing**
> Text goes here.

> [!CAUTION]
> **Firewall Isolation**
> Text goes here.

> [!TIP]
> **Pro-Tip**
> Text goes here.
```

## 8. Clean Clutter (Collapsible Sections)
If a section contains long lists, supplementary info, or deep-dive details that are not immediately necessary, wrap it in a `` block:
```html

🗺️ Erweiterte Topologien ansehen

Hier kommen die Details rein...

```

## 9. The Sign-Off
Every README MUST end with a horizontal rule and the official BDB DEV sign-off in italics:
```markdown
---
*Elevate your agency. Dominate the workflow.*
```

## Execution Flow
1. Analyze the project files to understand what the project does.
2. Generate the ASCII art for the header.
3. Draft the Mermaid diagram for the architecture.
4. Write the README applying all 9 rules above.
5. If modifying an existing README, DO NOT delete core technical information; reformat it to fit these rules.

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [hybridlabor-api](https://github.com/hybridlabor-api)
- **Source:** [hybridlabor-api/bdb-dev-optimized-agent-skills](https://github.com/hybridlabor-api/bdb-dev-optimized-agent-skills)
- **License:** Apache-2.0

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-hybridlabor-api-bdb-dev-optimized-agent-skills-bdreadme
- Seller: https://agentstack.voostack.com/s/hybridlabor-api
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.