From 0abe51b982f76e85444a40e6e1e21e5801f4c896 Mon Sep 17 00:00:00 2001 From: MrSphay Date: Sat, 2 May 2026 00:33:14 +0200 Subject: [PATCH] Add README section dividers --- README.md | 28 +++++++++++++++------------- blueprint.json | 8 +++++++- blueprint.md | 41 +++++++++++++++-------------------------- 3 files changed, 37 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 9c31fbd..a747d8c 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Version

---- +

-----------------------------------------------------

## Table of Contents @@ -29,7 +29,7 @@ - [Security](#security) - [Project Info](#project-info) ---- +

-----------------------------------------------------

## Overview @@ -37,7 +37,7 @@ EnvHelper reads `.env` files or plain text, detects `CHANGE_ME` placeholders, in The app is local-first. It does not send generated secrets or input files to external services. ---- +

-----------------------------------------------------

## Features @@ -52,7 +52,7 @@ The app is local-first. It does not send generated secrets or input files to ext | Languages | German, English, Spanish, French, and Dutch | | Build output | Windows setup and portable executables via Gitea Runner | ---- +

-----------------------------------------------------

## Workflow @@ -71,7 +71,7 @@ POSTGRES_PASSWORD=... -> Infer formats -> POSTGRES_PASSWORD=... SESSION_SECRET=... Generate local values SESSION_SECRET=... ``` ---- +

-----------------------------------------------------

## Example @@ -109,7 +109,7 @@ BOOTSTRAP_ADMIN_PASSWORD=Wz4...strongPassword The actual values are generated randomly on the local machine. ---- +

-----------------------------------------------------

## Placeholder Detection @@ -131,7 +131,7 @@ Supported examples: Additional heuristics cover common `.env.example` variables for SMTP, S3/MinIO, Redis, RabbitMQ, CORS, log levels, environment flags, and API keys. ---- +

-----------------------------------------------------

## Default Values @@ -148,7 +148,7 @@ Default values are shown in their own section. EnvHelper detects likely defaults Manual defaults can always be added. They override automatically detected defaults and only affect the output, never the input template. ---- +

-----------------------------------------------------

## Downloads and Artifacts @@ -161,7 +161,7 @@ EnvHelper-0.1.0-portable-x64.exe The files are published by the Gitea Runner as an Actions artifact and as a Generic Package. ---- +

-----------------------------------------------------

## Development @@ -189,7 +189,7 @@ Build Windows packages: npm run dist:win ``` ---- +

-----------------------------------------------------

## Windows Build @@ -208,7 +208,7 @@ The runner: 5. creates setup and portable executables, 6. uploads artifacts and packages to Gitea. ---- +

-----------------------------------------------------

## README Generation @@ -221,6 +221,8 @@ blueprint.md blueprint.json ``` +Section dividers are configured as the custom `section-line` template in `blueprint.json` and stamped from `blueprint.md`, so generated README updates keep the same rainbow separators. + Regenerate the README with: ```bash @@ -229,7 +231,7 @@ npm run readme The generated output is committed as `README.md` so Gitea can render it directly without any additional tooling. ---- +

-----------------------------------------------------

## Security @@ -248,7 +250,7 @@ WINDOWS_CSC_KEY_PASSWORD `WINDOWS_CSC_LINK` is the certificate, for example a Base64-encoded `.pfx` file or a reachable certificate URL. `WINDOWS_CSC_KEY_PASSWORD` is the certificate password. ---- +

-----------------------------------------------------

## Project Info diff --git a/blueprint.json b/blueprint.json index 1add75d..c2e1117 100644 --- a/blueprint.json +++ b/blueprint.json @@ -28,6 +28,12 @@ "1": "", "2": "" }, - "line": "https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png", + "line": "rainbow", + "templates": [ + { + "name": "section-line", + "template": "

\"-----------------------------------------------------\"

" + } + ], "text": "A local Windows desktop app for turning .env templates into deployable configuration files." } diff --git a/blueprint.md b/blueprint.md index 77e5bd6..beac2d0 100644 --- a/blueprint.md +++ b/blueprint.md @@ -2,20 +2,17 @@ {{ template:badges }} ---- - +{{ template:section-line }} {{ template:table-of-contents }} ---- - +{{ template:section-line }} ## Overview EnvHelper reads `.env` files or plain text, detects `CHANGE_ME` placeholders, infers the required value format, and produces a ready-to-use output file. Identical placeholders are replaced with the same generated value, so related variables such as `DATABASE_URL` and `POSTGRES_PASSWORD` stay in sync. The app is local-first. It does not send generated secrets or input files to external services. ---- - +{{ template:section-line }} ## Features | Area | Description | @@ -29,8 +26,7 @@ The app is local-first. It does not send generated secrets or input files to ext | Languages | German, English, Spanish, French, and Dutch | | Build output | Windows setup and portable executables via Gitea Runner | ---- - +{{ template:section-line }} ## Workflow ```text @@ -48,8 +44,7 @@ POSTGRES_PASSWORD=... -> Infer formats -> POSTGRES_PASSWORD=... SESSION_SECRET=... Generate local values SESSION_SECRET=... ``` ---- - +{{ template:section-line }} ## Example Input: @@ -86,8 +81,7 @@ BOOTSTRAP_ADMIN_PASSWORD=Wz4...strongPassword The actual values are generated randomly on the local machine. ---- - +{{ template:section-line }} ## Placeholder Detection EnvHelper prioritizes the placeholder text over the surrounding variable name. This prevents cases such as `CHANGE_ME_POSTGRES_PASSWORD` inside `DATABASE_URL` from being misclassified as a URL. @@ -108,8 +102,7 @@ Supported examples: Additional heuristics cover common `.env.example` variables for SMTP, S3/MinIO, Redis, RabbitMQ, CORS, log levels, environment flags, and API keys. ---- - +{{ template:section-line }} ## Default Values Default values are shown in their own section. EnvHelper detects likely defaults automatically, for example: @@ -125,8 +118,7 @@ Default values are shown in their own section. EnvHelper detects likely defaults Manual defaults can always be added. They override automatically detected defaults and only affect the output, never the input template. ---- - +{{ template:section-line }} ## Downloads and Artifacts The Windows build produces two executable artifacts: @@ -138,8 +130,7 @@ EnvHelper-0.1.0-portable-x64.exe The files are published by the Gitea Runner as an Actions artifact and as a Generic Package. ---- - +{{ template:section-line }} ## Development Install dependencies: @@ -166,8 +157,7 @@ Build Windows packages: npm run dist:win ``` ---- - +{{ template:section-line }} ## Windows Build The production Windows build runs through Gitea Actions: @@ -185,8 +175,7 @@ The runner: 5. creates setup and portable executables, 6. uploads artifacts and packages to Gitea. ---- - +{{ template:section-line }} ## README Generation The README structure follows the blueprint-based workflow from [`andreasbm/readme`](https://github.com/andreasbm/readme). @@ -198,6 +187,8 @@ blueprint.md blueprint.json ``` +Section dividers are configured as the custom `section-line` template in `blueprint.json` and stamped from `blueprint.md`, so generated README updates keep the same rainbow separators. + Regenerate the README with: ```bash @@ -206,8 +197,7 @@ npm run readme The generated output is committed as `README.md` so Gitea can render it directly without any additional tooling. ---- - +{{ template:section-line }} ## Security EnvHelper generates values locally in the renderer using Web Crypto. It is a helper for `.env` templates and is not a replacement for a central secret manager in production infrastructure. @@ -225,8 +215,7 @@ WINDOWS_CSC_KEY_PASSWORD `WINDOWS_CSC_LINK` is the certificate, for example a Base64-encoded `.pfx` file or a reachable certificate URL. `WINDOWS_CSC_KEY_PASSWORD` is the certificate password. ---- - +{{ template:section-line }} ## Project Info | Field | Value |